SuperAPI AI 工具集

blueprints-writing

写作与研究

查看项目

更新于 10-16 04:32

技能介绍

用途:技术蓝图记录系统内部如何运作,区别于用户文档(如何使用)和 README(项目概览)。适合为多组件复杂系统、公共 API 及其契约、架构决策及理由、代码中不明显的行文、系统间集成点编写蓝图;简单自文档化工具、测试文件、外部依赖则不必写。

主要能力:提供创建与更新蓝图的流程与结构模板。创建前必须先检查已有蓝图,并使用正确的 frontmatter 格式。示例命令:Glob("blueprints/*.md")、Grep("keyword", path: "blueprints/", output_mode: "files_with_matches")、Read("blueprints/authentication.md")、Write("blueprints/system-name.md", content_with_frontmatter)。frontmatter 格式为 name 与 summary 两字段。

文档结构:包含 Overview(存在原因、高层功能、在整体架构中的位置)、Architecture(组件、数据流、依赖)、API/Interface(函数、参数、返回值、异常、示例)、Configuration(配置项表格)、Behavior(正常流程、错误处理、边界情况)、Files(关键文件及作用)、Related Systems(相关系统链接)。

写作风格:要精确,例如“无效输入返回带字段名和原因的 ValidationError”;记录行为而非实现;包含具体示例;随代码变更同步更新,删除已删功能的文档,明确标记弃用功能。

常见错误:细节过多、上下文不足、文档过时、内容重复、聚焦实现而非契约。

限制:资料未提供该技能的安装方式、收费、平台支持或效果数据,暂未提供。