SuperAPI AI 工具集

doc-updater

编程与开发

查看项目

更新于 10-15 17:31

技能介绍

用途:在代码变更后维护与真实代码一致的文档,并根据源码生成架构 codemap。触发场景包括新增功能、API 路由变化、架构调整、依赖增删等。

主要能力:检测项目语言与结构(通过 go.mod、package.json、pyproject.toml),识别 workspace/包,定位入口点与框架模式;生成 docs/CODEMAPS/,每个主要架构领域一个文件,含 INDEX.md 与领域文件(如 frontend、backend/api、database/models 等,仅为实际存在的领域创建);刷新 README.md、docs/GUIDES/*.md、CONTRIBUTING.md;校验路径、链接、示例与时间戳。codemap 含最后更新时间、入口点、ASCII 架构图、关键模块表、数据流、外部依赖等,单个建议不超过 500 行。

使用方式:按语言选用工具,如 TypeScript/Node.js 用 npx madge --image graph.svg src/,Go 用 go mod graph | dot -Tsvg -o graph.svg,Python 用 pydeps src/ --output graph.svg。工作流为分析仓库结构、生成 codemap、更新文档、校验。参考资料包括 references/codemap-format.md、codemap-examples.md、scripts.md、scripts-go.md、maintenance.md、readme-template.md。

适用场景:代码架构或接口变化后需要同步文档、需要生成或更新项目 codemap、维护 README 与开发指南。

限制:文档中未提供安装步骤、具体平台支持、收费方式与效果数据;具体生成文件需依项目实际结构调整,仅为存在的领域创建 codemap。