SuperAPI AI 工具集

code-documenter

办公与效率

查看项目

更新于 10-16 01:07

技能介绍

用途:在完成重大功能、发布开源项目、文档与代码脱节或需要完善新项目文档时,分析代码库并生成面向读者的外部文档。不适用于开发中的未稳定功能、代码注释/文档字符串,也不用于从代码生成 API 参考。

主要能力:分为 Quick 模式(按变更增量更新,自动执行)与 Comprehensive 模式(新项目或大改时,协作式推进并设质量门)。第一阶段通过多个分析代理扫描项目结构、代码表面(API、组件、命令、导出)、依赖、Git 历史与现有文档并综合出计划;随后评估文档状态,若存在 .doc-state.json 清单则对比代码与上次文档状态,显示健康分、覆盖率、新鲜度与债务。接着确认受众(开发者/用户/两者)与深度(Standard 约 4000-7000 词,Deep 约 8000-12000 词)。再提出文档边界(公开表面、内部实现、基础设施、排除项),展示文档计划(结构、待更新/创建/删除文件、预估规模与目标健康分)后执行。

使用方式:由技能引导选择模式、回答受众与深度问题、批准或调整边界与计划。Comprehensive 模式在核心文档、参考文档、架构与决策、支持文档、打磨验证五个门逐步生成并等待审核;Quick 模式仅更新变更部分,保留未变区域的人工编辑。完成后产出文档文件、更新清单与 CHANGELOG、测试与校验脚本,并给出健康报告。

产物与限制:可生成 README、api/architecture/contributing/deployment/troubleshooting、examples、ADR、文档地图等,支持 Mermaid 图表与 GitHub Pages、ReadTheDocs、GitBook、MkDocs 托管配置检测。文件路径与结构以实际生成结果为准;安装命令、具体命令与调用方式资料未提供,暂未提供。