SuperAPI AI 工具集

documentation-and-adrs

写作与研究

查看项目

更新于 10-16 08:11

技能介绍

用途:记录决策而非仅记录代码,重点保存“为什么这样决定”——背景、约束与权衡,便于未来的人或智能体在代码库中协作。适用场景包括重大架构决策、方案选型、新增或修改公共API、发布改变用户可见行为的功能、新人(或智能体)入职、反复解释同一件事时。不应对显而易见的代码写文档,不写重复代码含义的注释,不为一次性原型写文档。

主要能力:1) 架构决策记录(ADR):记录框架/依赖选型、数据模型与库表设计、认证策略、API架构(REST/GraphQL/tRPC)、构建工具与基础设施等难以逆转的决策;模板含状态(Proposed/Accepted/Superseded/Deprecated)、日期、Context、Decision、Alternatives Considered、Consequences。遵循仓库已有ADR位置与编号,无约定时才用docs/decisions/。生命周期为PROPOSED→ACCEPTED→(SUPERSEDED或DEPRECATED),不删除旧ADR,决策变更时写新ADR引用并取代旧的。2) 内联文档:注释解释why而非what,写明非显而易见的意图与已知陷阱(如必须在首次渲染前调用)。3) API文档:优先TypeScript内联JSDoc(参数、返回、异常、示例),REST可用OpenAPI/Swagger。4) README:项目简介、Quick Start、命令表、架构概览、贡献指南。5) Changelog:按Added/Fixed/Changed记录已发布功能。6) 面向智能体的文档:CLAUDE.md/规则文件、规格文件、ADR与内联陷阱说明。

使用方式:按仓库规范编写;文档中的命令与代码保持原样,示例中的架构选型(如PostgreSQL)属虚构项目假设,非通用排名;OpenAPI与TypeScript片段为省略实现的部分摘录,不可直接运行。使用前需核对实际代码与测试输出,未决决策标为Proposed,不得擅自推断团队已接受。

限制:仅在任务与上游来源及本地项目上下文明确匹配时使用;应用变更前须验证命令、生成代码、依赖、凭据与外部服务行为;示例不能替代环境相关测试、安全审查,破坏性或高成本操作需用户批准。安装命令、收费与平台支持信息暂未提供。