SuperAPI AI 工具集

document-service

办公与效率

查看项目

更新于 10-15 19:58

技能介绍

用途:当用户要求分析代码库、为服务编写文档、生成技术文档或接手陌生代码时使用。它把代码库转成结构化技术文档与架构图,每条发现都标注来源文件与行号。

主要能力:解释架构“为什么”而非仅罗列组件;追踪 API 端点或消息处理器的端到端请求路径,记录中间步骤、转换、超时与失败点;对复杂逻辑(ML 流水线、业务规则引擎、状态机、自定义算法)做实现级深挖;暴露硬编码值、魔法数字、环境相关行为与未记录假设;用 [UNKNOWN]、[RISK]、[INFERRED]、[RATIONALE UNKNOWN] 标记未知与风险;核对 README 等文档与实际代码的差异;用 Mermaid 画流程/时序图,架构图优先调用 aws-architecture-diagram 技能生成 draw.io 文件,不可用时回退 Mermaid。

使用方式:第 1 步收集目标目录与已有文档,检查输出路径是否已存在 CODEBASE_ANALYSIS.md 并确认覆盖或改名;此后自动运行。第 2 步递归列文件、按排除规则与 .gitignore 过滤、检测项目类型与入口点,可运行 git branch -a 查看分支。第 3 步生成文档大纲。第 4 步按应用代码与 IaC 两条路径分析,CDK 项目单次同时处理。第 5 步生成图表,可尝试 drawio -x -f png -b 10 -o docs/<name>.drawio.png docs/<name>.drawio 导出 PNG。第 6 步汇总为 CODEBASE_ANALYSIS.md。

适用场景:接手无文档的遗留代码库、AWS 工作负载、需要可追溯引用的技术文档、需要失败模式与超时依赖链分析的运维场景。

限制:IaC 只读不修改;大型代码库用 .codebase-documentor-progress.md 跟踪进度,支持并行 worker;awsknowledge 与 awsiac MCP 服务器仅在检测到 AWS 服务或 CDK/CloudFormation 时用于校验与补充;Terraform 无该 MCP 模式校验;drawio 不在 PATH 时跳过 PNG 导出。具体收费、价格与平台支持暂未提供。