SuperAPI AI 工具集

design-documentation

设计与创作

查看项目

更新于 10-15 22:41

技能介绍

用途:在需求阶段完成并获批后,把需求转化为可指导实现的技术蓝图,适合多人协作、涉及复杂集成或需要记录架构决策的功能。

主要能力:提供标准设计文档模板(概述、架构、组件与接口、数据模型、错误处理、测试策略);给出分步流程:需求分析、调研与上下文构建、定义系统架构、设计组件与接口、定义数据模型、规划错误处理、定义测试策略;提供决策记录模板(背景、备选方案、决策、理由、影响),并列举 API 设计、数据存储、认证等常见决策示例;附质量检查清单(完整性、清晰度、可行性、可追溯性)与常见陷阱。

使用方式:按模板与步骤逐项填写;架构可用 Mermaid 图表达,接口可用 TypeScript 接口描述,数据模型可用表格与 JSON 示例说明,错误处理可用表格列出错误类型、HTTP 状态码、用户提示与系统动作。

适用场景:需求已批准、需要规划技术实现、多人共同开发、需要记录架构决策、功能涉及复杂集成时。

限制:资料未提供具体安装命令、收费方式、平台支持或效果数据;内容为文档编写方法指导,不替代实际架构评审与实现验证。