SuperAPI AI 工具集

documentation-and-adrs

写作与研究

查看项目

更新于 10-16 04:55

技能介绍

用途:该技能用于记录决策与文档,而非仅写代码。核心观点是:代码展示构建了什么,文档解释为什么这样构建、有哪些约束与取舍,这对未来的人和 AI 智能体都至关重要。若涉及编程相关文档或 ADR,应先加载 engineering-principles,以保留本地关于架构、测试、验证、工具与简洁性的标准。

主要能力:\n1. 架构决策记录(ADR):记录重要技术决策的推理过程,包括选择框架/库/主要依赖、数据模型或数据库模式、认证策略、API 架构(REST/GraphQL/tRPC)、构建工具与基础设施等难以逆转的决定。ADR 存放于 docs/decisions/ 并按序号编号,含状态、日期、上下文、决策、备选方案与后果。生命周期为 PROPOSED → ACCEPTED → (SUPERSEDED 或 DEPRECATED),决策变更时写新 ADR 引用并取代旧 ADR。\n2. 文本与文档风格:优先使用带图表、映射、紧凑表格和短小段落的丰富 Markdown 结构,避免超长平铺表格或深层嵌套列表。\n3. 行内文档:解释非显而易见的意图、业务规则与不变量,而非复述语法。不要为自解释代码加注释,不要留 TODO 当作待办,不要保留注释掉的代码(交给 git 历史)。已知陷阱应写在相关位置的行内注释中,并可引用 ADR。\n4. API 文档:进程内 TypeScript 接口可用 JSDoc 或类型接口记录参数、返回与异常。外部 HTTP 契约因类型在运行时被擦除,需选权威来源:紧密耦合的私有 TypeScript 系统用共享传输运行时 schema(如 Zod、Valibot)并推断类型;公开或跨仓库、跨语言 API 用完整 OpenAPI 文档作为权威契约,文档与生成客户端等为派生产物,且 OpenAPI 应生成并与端点行为保持一致。\n5. README 结构:项目名与一段描述、Quick Start(克隆、npm install、cp .env.example .env、npm run dev)、命令表、架构概览(链接 ADR)、贡献指南。\n 使用方式:在做出重大架构决策、比较方案、增改公开 API、发布改变用户行为的功能、新成员或智能体入职、反复解释同一件事时使用;不要为显而易见的代码或一次性原型写文档。面向智能体时,可借助 AGENTS.md / 规则文件、规格文件、ADR 与行内陷阱说明提供上下文。\n 限制与说明:资料未提供该技能的安装命令、收费与价格、平台支持等具体信息,此处暂未提供。应避免的常见合理化包括「代码自解释」「等 API 稳定再写文档」「没人读文档」「ADR 是开销」「注释会过时」;文档应解释意图而非复述代码。验证清单包括:为所有重大架构决策建立 ADR、README 覆盖快速开始与命令与架构、API 函数有参数与返回类型文档、已知陷阱就地记录、无注释掉的代码、规则文件保持最新。