SuperAPI AI 工具集

create-blueprint

通用与其它

查看项目

更新于 10-16 04:31

技能介绍

用途:针对代码库中的某个系统进行调研,生成或更新其技术蓝图文档,统一存放在仓库根目录的 blueprints/ 目录下。

主要能力:定位目标系统(功能名、目录路径或组件名);用 Glob、Grep 查找相关文件并阅读实现,梳理入口与公共 API、内部架构与数据流、依赖与集成、配置项、错误处理与边界情况;检查已有 README、代码注释、既有蓝图和测试文件;创建前先查重,避免重复或重叠文档。

使用方式:命令为 /blueprint <system-name>。蓝图必须写在仓库根目录,路径为 {repo-root}/blueprints/{system-name}.md,不能放在子目录或包内。文件需包含 YAML frontmatter(name、summary),正文按 Overview、Architecture(Components、Data Flow、Dependencies)、API / Interface、Behavior、Files、Related Systems 等结构组织。完成后用 Write 写入并报告已记录内容及可能需要补充文档的相关系统。

限制:蓝图索引 .claude/rules/blueprints/blueprints-index.md 由 SessionStart 钩子自动重新生成,无需手动更新。资料未提供收费、价格、平台支持范围等信息。