SuperAPI AI 工具集

technical-specification

写作与研究

查看项目

更新于 10-15 16:24

技能介绍

用途

该技能用于创建全面的技术规格文档,为软件项目定义系统需求、架构、实现细节与验收标准。适合在编写功能规格、系统设计文档、需求文档(PRD)、架构决策记录(ADR)、技术提案、RFC(Request for Comments)、API 设计规格、数据库模式设计时使用。

主要能力

该技能提供结构化的技术规格文档模板与参考指南,覆盖以下内容:

  • 执行摘要:用 2-3 句话概述规格内容与构建原因,包含问题、解决方案高层描述及预期业务/用户影响。
  • 背景:说明需要该功能的原因与上下文。
  • 功能需求。
  • 非功能需求。
  • 数据库模式。
  • API 数据模型。
  • 认证端点。
  • 限流。
  • 分阶段实施计划,例如:第 1 阶段核心认证(第 1-2 周)、第 2 阶段邮箱验证(第 3 周)、第 3 阶段社交登录(第 4 周)、第 4 阶段安全特性(第 5 周)等。
  • 最佳实践清单。

使用方式

文档模板包含以下头部字段:文档状态(Draft | Review | Approved | Implemented)、版本、作者、日期、评审人、最后更新。技能提供最小可用示例(Minimal working example)作为起点,并建议在 references/ 目录中查看各参考指南获取完整实现细节。

该技能列出最佳实践:

应做:为每项需求包含验收标准、提供架构图、记录 API 契约、明确性能要求、列出风险与缓解措施、包含实施时间线、添加成功指标、说明安全考量、对规格进行版本管理、获取相关方评审。

不应做:需求模糊、跳过非功能需求、忘记安全、忽略备选方案、跳过测试策略、遗漏监控/可观测性、留下未解答的问题。

适用场景

适用于功能规格、系统设计文档、需求文档(PRD)、架构决策记录(ADR)、技术提案、RFC、API 设计规格、数据库模式设计等。

限制

该技能主要提供文档模板与结构指引,不包含自动化实现、代码生成或验证功能。具体实现细节需参考 references/ 目录中的参考指南。资料中未提供该技能的收费、价格或平台信息。