SuperAPI AI 工具集

codebase-documentation

写作与研究

查看项目

更新于 10-16 05:44

技能介绍

用途:为已有代码库生成清晰、简洁的文档,供人和 AI 智能体作为导航使用,而非写成散文。

主要能力:按 AGENTS.md(入口,含项目概览与文档索引)→ docs/ 主题文档 → 代码 的层级组织;可选文档包括 high-level-design.md、各组件文件夹的 README.md/api.md/data-model.md,以及全局 api.md、data-model.md、codestyle.md、rationale.md、deployment.md。架构与流程可用 Mermaid 图;引用实现时给出仓库根目录起的相对路径,如 src/handler/auth.go:HandleLogin()。文档控制在 300 行以内,过长则拆分。

使用方式:这是多会话流程,每阶段(Phase)在一次对话中完成,进度记录在 docs/PLAN.md。每次调用先查 docs/PLAN.md:存在则读它、找下一个 [pending] 阶段并征得用户同意;不存在则从 Phase 1 开始。Phase 1 评估与探索:读顶层文件(如 go.mod、package.json、Cargo.toml、Makefile、Dockerfile),映射目录结构(深度 4-5),识别入口点、主包与关键抽象,检查已有文档与代码风格工具配置,并评估规模(小:<10 个包;中:10-30 个;大:30+ 或多服务/单仓)。Phase 2 提出 2-3 个文档结构方案供用户选择。Phase 3 生成文档计划写入 docs/PLAN.md,含有序阶段、每阶段要读的代码区域、覆盖内容、复杂度、依赖关系与待定问题。Phase 4-N 每会话只执行一个阶段,完成后必须更新 PLAN.md 标记 [done]、向用户汇报并确认,且当次不开始下一阶段;AGENTS.md 始终是最后阶段。

适用场景:中小型至大型代码库、单仓/工作区的文档梳理;单仓可选择每服务独立文档、单一根文档或混合方案。

限制:原文未提供安装命令、价格、平台与运行环境等具体信息;未提供的功能与效果均不应假定。文档不可代替代码,不应重复代码内容。