SuperAPI AI 工具集

build-project-docs

通用与其它

查看项目

更新于 10-16 06:51

技能介绍

用途:为项目创建分层式、对 LLM 友好的文档体系,让有限上下文窗口下也能按需加载信息。支持两种模式:已有项目梳理文档、新项目从 PRD 驱动开发。

主要能力:文档模式分 8 个阶段——项目探查、架构分类、编写 .claude/CLAUDE.md 主索引、基础模块文档、业务模块文档、配置层文档、变更日志(含风险评估与回滚指南)、交叉验证。新项目模式分 5 个阶段——PRD 解析、按脚手架规范设计架构、需求拆解为开发任务、生成 CLAUDE.md 开发指南、模块开发文档。

分层结构:.claude/CLAUDE.md 为主索引(始终加载);.claude/docs/{模块}/README.md 为模块级文档(按需加载);同目录下 *.md 为深度参考(API 详情、数据模型、坑点);CHANGELOG.md 记录模块变更历史。

使用方式:先做模式检测。已有代码且无 .claude/docs/ 时按顺序执行文档模式全部阶段;已存在时先读 .claude/docs/_progress.md 判断断点,跳到第一个未完成阶段继续,避免重复。提到 PRD、需求文档、新项目规划且项目为空时走新项目模式;若项目已有代码,则先用文档模式梳理,再用新项目模式阶段 1-3 做增量需求拆解。执行每个阶段前须阅读对应 reference 文件,并先展示结果给用户确认。

关键规则:多模块必须逐模块串行处理(从小到大),每完成一个模块即更新 _progress.md 并不再引用其源码;处理 3 个以上大模块后提示用户开新会话。只要模块对外暴露 API(Controller、@Tool、gRPC、Handler 等),就须按业务域拆分 api-{域}.md;每个业务模块须有 data-model.md 加 pitfalls.md(文档模式)或 dev-checklist.md(新项目模式);README 作为索引须链接所有子文件。文件大小限制:CLAUDE.md 150 行内,模块 README 200 行内,超 250 行须拆分。

限制:资料未提供具体安装命令、依赖环境、收费与平台支持信息,暂未提供。