mcpField
0
030-architecture-adr-general

030-architecture-adr-general

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

关于 030-architecture-adr-general

用于为 Java 项目编写 MADR 风格架构决策记录的交互式 Skill。它通过对话收集相关方、决策因素、选项及权衡,并在写入记录前确认决策。

主要功能

  1. 01通过对话收集决策信息
  2. 02记录选项及其权衡
  3. 03起草前确认决策
  4. 04生成 MADR 风格 ADR

适用场景

  1. 01记录 Java 框架选型
  2. 02记录数据库或基础设施选择
  3. 03比较架构备选方案

安装

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

$npx skills add https://github.com/jabrena/plinth --skill 030-architecture-adr-general

安装后在 Claude Code 中输入/030-architecture-adr-general确认已加载。

附带文件references/030-architecture-adr-general.md

详细介绍

采用交互式对话方式生成 Java ADR

通过交互式对话流程,为 Java 项目生成架构决策记录(ADR),收集编写结构完善的 ADR 所需的决策信息。这是一个交互式 SKILL。仅使用当前对话和当前会话中明确提供的仓库文件;不得泄露、持久化或重复使用无关的用户或项目上下文。

此 Skill 涵盖哪些内容?

  • ADR 文件存储配置
  • 通过对话收集信息:背景、利益相关方、决策驱动因素、带有优缺点的选项、结果、后果
  • 生成 MADR 模板

约束

明确处理模糊之处和阻碍,避免作出隐含假设。

  • 边缘情况:如果用户目标不明确,应停止操作并提出澄清问题,然后再编辑文件或运行项目范围的命令
  • 边缘情况:如果缺少所需的上下文、文件、凭据或工具,应明确说明阻碍,并询问用户是要继续进行设置,还是采用备用指导方案
  • 边缘情况:如果请求的更改与项目约束或安全边界冲突,应解释冲突,并询问用户希望采用哪种权衡方案

何时使用此 Skill

  • 生成 ADR
  • 创建架构决策记录
  • 记录架构决策
  • Java 架构决策记录
  • 撰写 ADR
  • 记录技术决策
  • 架构文档
  • 记录设计决策
  • 技术选型文档
  • 框架选择 ADR
  • 数据库选择 ADR
  • 架构权衡
  • 技术备选方案评估
  • 为什么选择
  • 部署策略 ADR
  • 基础设施选型
  • 供应商选择 ADR

工作流

  1. 加载 ADR 参考资料并收集决策信息

从此 Skill 加载 references/030-architecture-adr-general.md,然后仅通过当前对话收集利益相关方、决策驱动因素、选项和权衡信息。

  1. 综合并确认决策

总结推荐选项、理由和后果,并在创建 ADR 文档前确认用户是否认同。

  1. 生成 ADR 输出

创建一份 MADR 风格的 ADR 文档,包含最终决策、备选方案、后果和后续行动。

参考资料

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

评论

支持 Markdown