SuperAPI AI 工具集

design-doc

设计与创作

查看项目

更新于 10-15 21:10

技能介绍

用途:为新功能、系统、重构计划、API 设计与数据库模式创建结构化技术设计文档(TRD),传达系统行为、实现思路与验收标准。

主要能力:提供文档模板与写作规范,覆盖核心章节:背景与动机(问题陈述、目标、非目标)、实现考量(约束与设计原则)、高层行为(端到端系统行为)、领域相关章节(按功能类型适配:发现、校验、API、状态、渲染)、错误处理与用户体验、面向未来的可扩展性设计、实现大纲、测试方法(单元、集成、手工测试)、验收标准。

使用方式:按工作流执行——收集上下文,理解功能或系统范围、约束与目标;起草结构,使用 references/template.md 中的模板;逐节填写,必要时提出澄清问题;复核验收标准是否可测试、实现大纲是否可执行。

写作规范:章节标题使用 --- 下划线(Setext 风格);行为描述用现在时(loads、validates、returns);具体量化(如 max 100 chars,而非“合理长度”);行为有变化时给出具体示例;非目标与目标同等重要,防止范围蔓延;验收标准必须可验证,不能主观。

适用场景:需要编写设计文档、TRD,或在功能开发前对齐实现方案与验收标准时。

限制:具体模板内容见 references/template.md;官方文档未提供更多收费、平台或运行时信息。