为项目构建分层式 LLM 友好文档体系，让 AI Agent 高效理解和操作你的代码库。
LLM 上下文窗口有限，文档必须分层加载：
.claude/
├── CLAUDE.md 主索引（项目地图，始终加载）≤150行
└── docs/
└── {模块}/
├── README.md 模块概览（按需加载）≤200行
├── api-{域}.md API 详情
├── data-model.md 数据模型
├── pitfalls.md 坑点陷阱（文档模式）
├── dev-checklist.md 开发清单（新项目模式）
└── CHANGELOG.md 变更历史
扫描已有代码，生成完整文档体系。8 个阶段：
| 阶段 | 内容 | 产出 |
|---|---|---|
| 1 | 项目探查 | 目录结构、技术栈、依赖关系 |
| 2 | 架构分类 | 模块分层（基础/业务/配置） |
| 3 | 编写 CLAUDE.md | 项目主索引 |
| 4 | 基础模块文档 | 共享工具、通用组件 |
| 5 | 业务模块文档 | API + 数据模型 + 坑点 |
| 6 | 配置层文档 | 环境配置、部署差异 |
| 7 | 变更日志 | git 历史分析，风险评估+回滚指南 |
| 8 | 交叉验证 | 一致性检查、链接验证 |
支持增量更新——中断后新会话自动从断点继续。
从需求文档出发，生成架构设计和开发规范。5 个阶段：
| 阶段 | 内容 | 产出 |
|---|---|---|
| 1 | PRD 解析 | 需求理解、功能清单 |
| 2 | 架构设计 | 按脚手架规范设计模块结构 |
| 3 | 需求拆解 | 开发任务分解 |
| 4 | 生成 CLAUDE.md | 融合代码规范的开发指南 |
| 5 | 模块开发文档 | API 设计 + 数据模型 + 开发清单 |
内置 Java 代码规范和 Spring Boot 脚手架规范参考。
# 已有项目：在项目根目录执行
/build-project-docs
# 新项目：提供 PRD 文件
/build-project-docs 这是我的 PRD：...
自动检测模式：有源代码 → 文档模式，空项目+PRD → 新项目模式。
- 断点续传 —
_progress.md追踪进度，会话中断后自动恢复 - 逐模块处理 — 避免上下文溢出，串行处理大项目
- 增量更新 — 检测源码变更，只更新过期文档
- 交叉验证 — 最终阶段检查文档一致性和链接完整性
- git（用于变更日志分析）
MIT