SuperAPI AI 工具集

bmad-index-docs

办公与效率

查看项目

更新于 10-15 20:07

技能介绍

用途:为指定目标文件夹生成或更新 index.md,用索引方式引用文件夹内的全部文档。当用户请求为某个目录创建或更新文件索引时使用。

主要能力与执行流程:

  1. 扫描目录:列出目标位置的所有文件和子目录。
  2. 分组内容:按类型、用途或子目录组织文件。
  3. 生成描述:读取每个文件以理解其实际用途,并基于内容而非仅文件名生成简短描述(3-10 个词)。
  4. 创建或更新索引:写入或更新 index.md,包含组织好的文件清单。

输出格式:以“# Directory Index”为标题,下设“## Files”列出文件,格式为“- filename.ext - 简要描述”;再设“## Subdirectories”,按子文件夹分组,每项同样为“- file1.ext - 简要描述”。

验证与规则:使用以 ./ 开头的相对路径;将相似文件归为一组;读取文件内容以生成准确描述,不猜测文件名;描述简洁但有信息量(3-10 个词);组内按字母排序;除非特别指定,跳过以 . 开头的隐藏文件。

停止条件:目标目录不存在或无法访问时停止;用户没有创建 index.md 的写入权限时停止。

限制:资料未提供该技能的收费、价格、平台或安装命令等信息。