SuperAPI AI 工具集

032-architecture-adr-functional-requirements-rest

编程与开发

查看项目

更新于 10-15 22:39

技能介绍

用途:为 REST API 开发创建架构决策记录(ADR),通过结构化对话引导相关方梳理并记录技术决策与功能需求;ADR 是该对话的文档化结果,而非对话本身。

主要能力:覆盖初始上下文(API 目的、消费者、约束、负载);功能需求(用例、资源、操作、响应格式、错误处理);技术决策(语言/框架、API 设计、认证与安全、数据、集成、基础设施、测试、监控);决策综合与验证;ADR 文档生成与后续步骤。

使用方式:以对话式发现推进,一次只问 1 至 2 个问题,基于回答深入,并在继续前验证。开始前必须运行 date 以获取 ADR 的准确时间戳;必须重新读取参考模板,不得使用缓存问题;必须在提议创建 ADR 前向用户确认摘要,例如询问是否准确捕获了需求;必须等待用户确认 proceed 后才生成 ADR。详细指导、示例与约束见 references/032-architecture-adr-functional-requirements-rest.md。

限制:仅应在充分对话且用户确认后创建 ADR;不得一次提出所有问题;资料未提供具体模板内容与更多实现细节。