SuperAPI AI 工具集

technical-spec-writing

写作与研究

查看项目

更新于 10-16 00:29

技能介绍

用途:创建面向实现的技术规格,把产品需求翻译为具体系统设计,覆盖架构、API、数据模型与运维关注点。

主要能力:技能按步骤引导撰写,包括上下文收集(调用 check-history,参考父 PRD、功能规格、现有架构、技术约束、非功能需求与集成点)、系统概览(问题、方案、关键设计决策、范围)、组件架构(组件图与各组件职责、输入、输出、依赖)、API 设计(HTTP 方法、路径、鉴权、请求/响应 schema、错误响应表)、数据模型(表字段约束、索引、关系与实体图)、实现方法(伪代码、关键考虑、设计模式表)、测试策略(单元、集成、E2E、性能测试)、性能考虑(指标目标与缓存、数据库、异步优化)、安全考虑(认证、授权、数据保护、输入校验与安全检查清单)、迁移与回滚(迁移步骤、数据库迁移、回滚计划、功能开关、灰度发布),最后按 TEMPLATE.md 生成输出并核对清单。

使用方式:提供项目上下文与源文档,按工作流逐步填写各章节;伪代码保留设计意图,不写实际实现代码。

适用场景:需要把需求落为可实现的技术方案时,例如电商运费 API、SaaS 权限系统、金融交易告警系统等。

限制:不用于产品需求(用 prd-writing)、功能规格(用 feature-spec-writing)、实现任务拆解(用 sparc-planning)、现有代码 API 文档(用 api-doc-writer)、技术规格评审(用 technical-spec-reviewing)。应避免缺少理由、性能目标含糊、无错误处理、在技术规格中写实际代码等反模式。参考资源为 TEMPLATE.md 与 REFERENCE.md;相关 agent 为 specification-architect。具体安装命令与收费信息资料未提供。