mcpField
B
bmad-index-docs

bmad-index-docs

github.com/bmad-code-org文档处理54.7k259 次安装1 周前更新
代码仓库

关于 bmad-index-docs

此 skill 扫描目标目录、分组文件，并根据实际内容撰写简短说明，以创建或更新 `index.md`，适用于整理文档目录。

主要功能

  1. 01扫描文件与子目录
  2. 02按类型或用途分组
  3. 03根据内容撰写说明
  4. 04创建或更新 index.md
  5. 05按组排序并使用相对路径

适用场景

  1. 01为文档文件夹创建索引
  2. 02文件变更后更新目录清单

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/bmad-code-org/bmad-method --skill bmad-index-docs

安装后在 Claude Code 中输入/bmad-index-docs确认已加载。

详细介绍

索引文档

目标： 生成或更新 index.md，以引用目标文件夹中的所有文档。

执行

第 1 步：扫描目录
  • 列出目标位置中的所有文件和子目录
第 2 步：对内容分组
  • 按类型、用途或子目录组织文件
第 3 步：生成描述
  • 读取每个文件以了解其实际用途，并根据内容创建简短（3-10 个词）的描述，而不仅仅是根据文件名
第 4 步：创建/更新索引
  • 写入或更新 index.md，包含有条理的文件列表

输出格式

# Directory Index

## Files

- **[filename.ext](./filename.ext)** - Brief description
- **[another-file.ext](./another-file.ext)** - Brief description

## Subdirectories

### subfolder/

- **[file1.ext](./subfolder/file1.ext)** - Brief description
- **[file2.ext](./subfolder/file2.ext)** - Brief description

### another-folder/

- **[file3.ext](./another-folder/file3.ext)** - Brief description

停止条件

  • 如果目标目录不存在或无法访问，则停止
  • 如果用户没有创建 index.md 的写入权限，则停止

验证

  • 使用以 ./ 开头的相对路径
  • 将相似文件分组在一起
  • 读取文件内容以生成准确的描述——不要根据文件名猜测
  • 保持描述简洁但信息充分（3-10 个词）
  • 在组内按字母顺序排序
  • 跳过隐藏文件（以 . 开头），除非另有指定

评论

支持 Markdown