SuperAPI AI 工具集

document-features

办公与效率

查看项目

更新于 10-15 21:55

技能介绍

用途:为仓库的功能区域生成文档文件 <docs-dir>/features/<slug>.md。它是 find-features 的配套工具:前者发现缺失项,本技能负责按用户点名的功能并行填充模板。若用户要“查找并记录所有”,可先运行 find-features 得到候选清单再交给本技能;若已明确功能(如“document auth and billing”),可直接使用。

主要流程:第一阶段确认前置条件并定位文档目录。读取仓库根 AGENTS.md,其中列出的路径目录即为 <docs-dir>(默认 agents-docs/,可用 --docs-dir 覆盖);若缺失则回退查找 AGENTS_FEATURES.md(find . -maxdepth 3 -name AGENTS_FEATURES.md)。需存在 <docs-dir>/AGENTS_FEATURES.md、<docs-dir>/features/feature-template.md、<docs-dir>/FEATURES.md,缺一则提示需先运行 setup-agentic-repository 并停止,不自行搭建。第二阶段决定记录范围:解析用户指定的功能名、数量或“all”,也可用 AskUserQuestion 询问;清点 features/ 目录并跳过已文档化的 slug,无法在代码中定位的功能需询问跳过或建 TODO,不虚构功能区。第三阶段并行派发子代理:每功能一个,同一条消息内调用,并发上限 10,超出则分批;子代理提示需自包含,并将 <docs-dir> 替换为实际路径。子代理读取契约与模板,定位代码确认有实质实现,从模板生成文档,设置 Area、Status、Last updated,无法确认的段落保留 TODO,不编辑 FEATURES.md、不提交。第四阶段按字母序更新 <docs-dir>/FEATURES.md 索引并汇报创建、跳过、TODO 与差异,不提交改动。

适用场景:已有 Mimas 模板初始化的仓库、需要批量补齐功能文档的工作。限制:需先具备前置文件与模板;并发不超过 10;不自行创建模板或索引外文件;不提交改动;不编造内容,缺失信息以 TODO 标注。