用途
generate-blueprints 用于全面记录代码库中的所有系统:通过创建或更新仓库根目录下的 blueprints/ 目录,为每个主要系统生成技术文档。其核心定位是:蓝图是仓库级的系统设计文档,系统可能跨越多个包或目录,但所有蓝图都必须集中放在仓库根目录下的单一 blueprints/ 目录中,绝不能放在子目录或包内。
主要能力
- 系统发现:分析项目结构,识别所有主要系统,包括顶层目录及其用途、包/模块边界、入口点(主文件、CLI 命令、API 端点)以及配置系统;同时读取各级 README、已有 blueprints/ 目录、内联文档模式和测试文件。
- 蓝图审计:使用 Glob("blueprints/*.md") 列出所有已有蓝图文件,用 Read("blueprints/{name}.md") 逐一检查文档是否与当前实现一致、是否有新功能未记录、是否有已移除功能仍被记录,并识别针对已移除系统的孤立蓝图。
- 优先级排序:按核心系统、公共 API、集成点、支撑系统(工具与辅助)的顺序排列文档化工作。
- 文档生成:对每个系统使用 Write 工具创建或更新蓝图文件,路径为 blueprints/{system-name}.md。
- 去重策略:创建前用 Glob 和 Grep 检查已有覆盖,读取现有蓝图,合并紧密耦合的系统,使用交叉引用而非复制,保证每个概念只在一处记录。
使用方式
调用方式为斜杠命令 /blueprints。执行过程分为五个阶段:发现、审计现有蓝图、排定文档优先级、生成文档、索引管理。
生成的每份蓝图文件必须包含 YAML frontmatter,包含 name 与 summary 字段,正文建议包含 Overview(目的与在整体系统中的角色)、Architecture(结构、组件、数据流)、API / Interface(公共方法、命令、配置)、Behavior(正常操作、错误处理、边界情况)、Files(关键实现文件及说明)、Related Systems(指向相关蓝图的链接)。
索引由 SessionStart 钩子自动管理:运行 han blueprints sync-index 后,索引会更新到 .claude/rules/blueprints/blueprints-index.md。无需手动创建或更新索引文件,只需专注于用 Write 工具生成高质量蓝图内容。frontmatter 中的 name 与 summary 字段使文档可被自动生成的索引发现。
适用场景
- 为多包、多目录的仓库建立统一的系统设计文档。
- 审计现有蓝图与当前实现的一致性,发现文档缺口与孤立文档。
- 在代码库演进后更新系统级技术文档。
限制
- 蓝图必须位于仓库根目录的 blueprints/ 下,不得放在子目录或包内。
- 索引由钩子自动管理,不应手动维护。
- 完成后需列出所有发现的系统、创建/更新的蓝图、无法记录的系统及原因,以及未来需要补充文档的领域。
- 关于收费、价格、支持平台等具体信息,资料中暂未提供。