用途:核查代码库的文档覆盖情况,报告缺口,并可生成缺失文档。覆盖有两个互补维度:符号覆盖率(函数、类、模块是否按语言标准写好 docstrings、JSDoc、GoDoc 等)与 Diataxis 类型平衡(文档整体是否满足 Tutorial、How-To、Reference、Explanation 四类需求)。工作流按顺序执行:语言检测(须有匹配源文件证据,否则以“no applicable languages”结束);加载各语言标准(如 Google docstrings、JSDoc、GoDoc);逐语言验证,agent 支持子代理时按语言并行,否则顺序执行,输出一致;对既有文档(docs/ 目录、README、wiki)做 Diataxis 平衡检查,逐类标注 yes/no/thin;合并生成报告(含汇总表、严重性分组与详细发现,兼顾符号覆盖与类型平衡);仅在用户明确选择生成时才应用文档编辑,缺失的 Diataxis 类型应走 draft-docs,不内联生成;生成后按参考文件 Phase 5 的 linter 命令做后置验证。限制与注意:用 --report-only 可跳过生成;避免检查测试文件(测试辅助文件除外);不为缺失类型生成空骨架,建议按价值优先推荐单篇文档并用 draft-docs 起草;混合类型页面(如 how-to 中嵌参考表)建议用 improve-doc 拆分。使用方式以技能命令与 references/workflow.md 各阶段为准,其余平台支持、价格等信息暂未提供。
ensure-docs
写作与研究
更新于 10-15 21:39