mcpField
0
031-architecture-adr-functional-requirements

031-architecture-adr-functional-requirements

github.com/jabrena开发456289 次安装1 天前更新
代码仓库

关于 031-architecture-adr-functional-requirements

交互式 Skill,通过分步访谈梳理命令行工具和/或 REST API 的功能需求与技术决策,并在确认后写入 ADR。它要求先验证总结,再等待用户批准生成文档。

主要功能

  1. 01识别命令行与 API 范围
  2. 02结构化需求访谈
  3. 03汇总技术决策
  4. 04生成 ADR 前由用户验证
  5. 05确认后生成 ADR

适用场景

  1. 01梳理新命令行工具需求
  2. 02记录 REST API 决策
  3. 03明确横跨命令行与 API 的需求

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jabrena/plinth --skill 031-architecture-adr-functional-requirements

安装后在 Claude Code 中输入/031-architecture-adr-functional-requirements确认已加载。

附带文件references/031-architecture-adr-functional-requirements.md

详细介绍

为功能需求创建 ADR(CLI 和/或 REST API)

通过结构化对话,引导相关人员梳理并记录命令行工具、REST/HTTP API 或两者结合的技术决策和功能需求。这是一个交互式 SKILL。ADR 是这场对话的记录,而不是对话本身。尽可能根据当前工作区判断是 CLI 还是 API;不明确时,提出一个简短的澄清问题。仅使用当前会话中的对话内容和明确可用的仓库文件。

此 Skill 涵盖哪些内容?

  • 接口形式发现:CLI、REST/HTTP API 或两者(推断并确认)
  • 初始背景:用途、用户/使用方、约束、时间线、负载(与 API 相关时)
  • 功能需求:特定接口形式的工作流、输入/输出、资源、错误
  • 技术决策:语言/框架;REST 部分(API 设计、身份验证、数据、基础设施、测试/监控)和/或 CLI 部分(架构、数据/集成、测试/分发)
  • ADR 创建前的决策综合与验证
  • ADR 文档生成及后续步骤

约束

通过分批的小步对话进行梳理,根据回答逐步深入,并在继续前进行验证。只有经过充分对话并获得用户确认后,才能创建 ADR。

  • 强制要求:开始前使用本地 shell 的 date 命令,获取 ADR 的准确时间戳
  • 必须:在当前会话中加载随附的参考模板;忽略此前会话中的内容,除非用户再次提供
  • 必须:每次只提出一两个梳理问题;绝不能一次性提出所有问题
  • 必须:在提议创建 ADR 前,先与用户确认总结是否准确(这是否准确概括了你的需求?)
  • 必须:等待用户确认继续后,才能生成 ADR

何时使用此 Skill

  • 为功能需求创建 ADR
  • 记录功能需求
  • 收集功能需求
  • 在 ADR 中生成功能需求
  • 为 ADR 决定 CLI 与 REST 的功能需求

工作流

  1. 获取当前日期

在梳理前使用本地 shell 的 date 命令,并将其用于 ADR 时间戳。

  1. 加载参考资料并梳理接口形式范围

从此 skill 加载 references/031-architecture-adr-functional-requirements.md,根据当前工作区推断 CLI/API 范围;如不明确,提出一个简短的澄清问题。

  1. 进行对话式梳理

分批引导梳理,收集 CLI、REST API 或两者的功能需求和技术决策。

步骤约束:

  • 绝不能一次性提出所有梳理问题
  • 提议生成 ADR 前,先与用户确认总结
  1. 获得明确确认后生成 ADR

只有在用户确认继续后,才能生成 ADR 文档并提供简洁的后续步骤。

参考资料

详细指南、示例和约束请参阅 references/031-architecture-adr-functional-requirements.md。

评论

支持 Markdown