| name | dev-blueprint |
| description | 分析 GitHub 项目或本地代码库,以此为参考生成从零开发一个新项目的完整文档套件(产品手册、开发文档、架构文档、目录结构文档、设计规范文档、开发步骤计划、实施步骤文档、数据库设计文档、部署文档),并附带 AGENTS.md 指引 AI 开发工具执行开发。 当用户提供一个参考项目(GitHub 链接或本地路径),要求生成开发计划、开发文档、项目蓝图、功能拆解、实施步骤,或要求基于某个项目从零开发类似项目时使用。 允许用户指定技术栈替换、功能增减、聚焦特定模块。 适用于中文请求,例如"参考这个项目生成开发计划"、"基于这个 GitHub 项目给我一套开发方案"、"生成项目蓝图"、"输出开发步骤"、"我想做一个类似 xxx 的项目"等。
|
Dev Blueprint
分析一个参考项目(GitHub 链接或本地路径),理解其架构、功能和实现方式,然后以此为依据生成从零开发一个新项目所需的完整 Markdown 文档套件。新项目可以与参考项目不同:支持换技术栈、增减功能、聚焦特定模块。产出文档包含足够的架构设计和操作细节,可直接用于 Codex 等 AI 开发工具从零开发。
工作流程
第一步:获取参考项目
识别参考项目来源:
- GitHub URL 或
org/repo:浅克隆到新临时目录(git clone --depth 1),按本地仓库分析。克隆目录不能覆盖已有文件。
- 本地路径:直接分析。
- 克隆失败:降级使用远程 README、文件树,说明限制。
第二步:确定新项目范围
这是关键一步。明确新项目与参考项目之间的差异:
- 功能取舍:参考项目的哪些功能要保留?哪些去掉?要新增什么功能?
- 技术栈:是否换技术栈?如果用户没有指定,默认沿用参考项目的技术栈,但要说明这个默认选择。
- 范围限定:是做全部功能还是只做某些模块?
如果用户只提供了项目链接没有说明上述信息,主动询问。典型提问:
"你希望新项目和参考项目有哪些不同?比如:要保留/去掉哪些功能?需要换技术栈吗?是全部功能还是只做某些模块?"
如果用户明确表示"照着做就行",则默认完全复刻参考项目,所有功能保留。
第三步:分析参考项目
按 references/analysis-guide.md 的维度分析参考项目。重点关注:
- 功能全貌和模块划分。
- 架构模式和分层设计。
- 核心数据流和模块依赖关系。
- 数据模型与持久化。
- 设计模式和编码约定。
分析时引用源码路径和行号作为证据。读取 references/analysis-guide.md 获取完整分析维度清单。
第四步:生成文档
按 references/doc-templates.md 的模板生成文档。每份文档输出为独立的 .md 文件,文件名带两位序号前缀,描述的是新项目而非参考项目。
生成顺序(序号即阅读顺序):
AGENTS.md — AI 开发指引(最先读取,最后生成或与第一步文档一起生成)
01产品手册.md
02开发文档.md
03项目架构文档.md
04目录结构文档.md
05设计规范文档.md
06数据库设计文档.md(仅当新项目使用数据库)
07开发步骤计划文档.md
08实施步骤文档.md
09部署文档.md
后面的文档依赖前面文档的分析结果。AGENTS.md 在所有其他文档生成完毕后最后生成,因为它需要引用全部文档的内容和顺序。
读取 references/doc-templates.md 获取每份文档的完整结构模板。
产出文档清单
| 序号 | 文档 | 文件名 | 输出位置 | 条件 |
|---|
| — | AI 开发指引 | AGENTS.md | 项目根目录 | 总是 |
| 01 | 产品手册 | 01产品手册.md | docs/ | 总是 |
| 02 | 开发文档 | 02开发文档.md | docs/ | 总是 |
| 03 | 项目架构文档 | 03项目架构文档.md | docs/ | 总是 |
| 04 | 目录结构文档 | 04目录结构文档.md | docs/ | 总是 |
| 05 | 设计规范文档 | 05设计规范文档.md | docs/ | 总是 |
| 06 | 数据库设计文档 | 06数据库设计文档.md | docs/ | 仅当新项目使用数据库 |
| 07 | 开发步骤计划 | 07开发步骤计划文档.md | docs/ | 总是 |
| 08 | 实施步骤文档 | 08实施步骤文档.md | docs/ | 总是 |
| 09 | 部署文档 | 09部署文档.md | docs/ | 总是 |
输出规则
- 所有文档描述的是新项目,参考项目仅在分析阶段出现。
- 所有文档使用中文,技术术语保留英文(如 RESTful、CRUD、middleware、ORM、SSR)。
AGENTS.md 输出到新项目根目录;其余带序号文档输出到 docs/ 目录下。
- 每份文档独立输出为
.md 文件,文件名按上表(含两位序号前缀,序号决定排列和阅读顺序)。
- 技术判断需引用参考项目源码路径或文件名作为分析依据。
- 实施步骤文档需具体到文件路径和操作指令,使 AI 开发工具可直接执行。
- 如果用户未指定输出目录,在当前工作目录下创建以新项目名命名的文件夹作为项目根目录,其中
AGENTS.md 放在根目录,其余文档放在 docs/ 子目录下。