用途:系统化审计、整理并修复项目文档,通过对比代码库与现有文档,发现文档的过时、缺失与错位问题。触发时机:合并功能分支或完成重构后、依赖升级或 API 变更后、新人上手反馈文档困惑时、按月或按发布周期定期维护、或手动运行脚本发现问题时。
主要能力与流程:
- 审计:运行 python3 skills/doc-maintenance/scripts/doc_audit.py 得到基线报告,覆盖失效内部链接、孤立文档、缺失的必需结构、相对代码过时、空文件或存根文件;可加 --json 输出机器可读结果,加 --root PATH 覆盖项目根目录检测。随后并行调度搜索代理进行代码到文档覆盖、文档到代码新鲜度、结构合规、ASCII 图检测与缺失图判断等分析,并将脚本输出与代理发现去重合并。
- 分诊:把发现归为 stale、missing、orphan、misplaced、irrelevant、structural、diagram-convert、diagram-missing 等类别,并分配 P0 至 P4 级别。
- 修复:按文档类型分派 reference-builder、technical-writer、learning-guide、mermaid-expert 等代理,独立任务并行,存在依赖时串行,每批最多 4 个修复代理;更新已有文档时提供当前内容与具体问题,要求最小化针对性修改;新建文档时提供源码、目标路径与结构规范。
- 质量门:由 docs-architect 审查全部改动,检查准确性、完整性、组织、交叉引用、一致性以及是否存在孤立文档;不通过则回到修复阶段,最多循环 2 次后升级给用户。
目录规范:docs/ 存放内部与开发者文档,含 architecture、development、plans、reviews、testing、reports、security、api、reference、ideas、archive;manual/ 存放用户文档,含 getting-started、guides、tutorials、reference、troubleshooting;根目录 README.md 仅审计准确性、不重组。
限制与注意事项:不得在未确认功能确已移除时删除文档;重组文档须同步更新全部内部交叉引用;不得为填充目录而创建空存根;docs/ 与 manual/ 之间不得重复内容,应使用链接;不得将用户文档移入 docs/ 或将开发者文档移入 manual/。质量门最多 2 次修复循环。具体代理提示模板与文件夹结构详见 references/agent-dispatch.md 和 references/folder-structure.md。