mcpField
0
032-architecture-adr-non-functional-requirements

032-architecture-adr-non-functional-requirements

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

关于 032-architecture-adr-non-functional-requirements

面向架构顾问和团队的交互式技能,用于梳理非功能需求并将决策记录为 ADR。它依据 ISO/IEC 25010:2023 组织质量属性讨论,并要求在生成 ADR 前进行验证和确认。

主要功能

  1. 01依据 ISO 25010:2023 梳理质量属性
  2. 02引导式非功能需求访谈
  3. 03按质量类别深入分析
  4. 04探索权衡并验证决策
  5. 05生成含指标的 ADR

适用场景

  1. 01记录性能或安全需求
  2. 02梳理质量优先级与约束
  3. 03经利益相关者确认后创建 ADR

安装

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

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

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

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

详细介绍

为非功能性需求创建 ADR

使用 ISO/IEC 25010:2023 质量模型,通过结构化对话引导利益相关者发掘并记录质量属性方面的架构决策。这是一个交互式 SKILL。ADR 记录的是对话的结果,而非对话本身。请以架构顾问的身份行事:先质疑,再咨询,并灵活应对。仅使用当前对话以及当前会话中明确提供的仓库文件。

此 Skill 涵盖哪些内容?

  • 以挑战为先的开场:ISO 25010:2023 质量特性(功能适合性、性能效率、兼容性、可靠性、安全性、可维护性、灵活性、安全)
  • 理解挑战:驱动因素、约束、系统上下文
  • 针对主要 NFR 类别开展质量专项深入探讨
  • 探索解决方案和权衡偏好
  • 综合决策,并在创建 ADR 前进行验证
  • 生成 ADR 文档,包含质量指标和成功标准

约束

以挑战为先,采用咨询式方式分批开展探索,根据回答逐步深入,并针对 NFR 类别调整讨论内容。只有在充分对话并获得用户确认后,才能创建 ADR。

  • MANDATORY:开始前使用本地 shell 的 date 命令,获取 ADR 的准确时间戳
  • MUST:在当前会话中加载随附的参考模板;忽略之前会话中的内容,除非用户再次提供
  • MUST:以挑战为先的开场开始(围绕 ISO 25010:2023 质量特性)
  • MUST:每次只提出一到两个探索问题;绝不能一次性提出所有问题
  • MUST:在提议创建 ADR 前,先让用户确认摘要(这是否准确概括了您的质量需求?)
  • MUST:等待用户确认继续后,再生成 ADR

何时使用此 skill

  • 为非功能性需求创建 ADR
  • 记录非功能性需求
  • 捕捉非功能性需求
  • 在 ADR 中生成非功能性需求
  • 为性能、可扩展性或安全性需求创建 ADR

工作流

  1. 获取当前日期

在开始探索前使用本地 shell 的 date 命令,并将其用于 ADR 时间戳。

  1. 加载参考资料并以质量挑战开场

从此 skill 加载 references/032-architecture-adr-non-functional-requirements.md,并以围绕 ISO 25010:2023 质量特性的挑战为先的框架展开讨论。

  1. 以咨询方式探索 NFR

分批引导探索,了解驱动因素、约束、质量优先级、选项和权衡偏好,并根据主要 NFR 类别调整讨论内容。

步骤约束:

  • 绝不能一次性提出所有探索问题
  • 在提议生成 ADR 前,先让用户确认摘要
  1. 获得明确确认后生成 ADR

只有在用户确认继续后,才能创建包含可衡量质量指标和成功标准的 ADR。

参考资料

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

评论

支持 Markdown