简诗架构决策记录
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_fccf428b/architecture-decision-records-management。
技能介绍
为什么需要记录架构决策?
代码仓库能展示系统“做了什么”,却往往无法解释“为什么这么做”。随着项目迭代,技术选型背后的上下文极易丢失,导致后来者重复造轮子,或者对历史遗留设计感到困惑。架构决策记录(ADR)正是为了解决这个问题,它强制团队在实施前捕捉Context(背景)、Decision(决策)与 Consequences(后果),将隐性的技术债显性化。
核心能力与工作流
该技能提供了一套完整的 ADR 管理规范。首先明确了触发边界:在引入新框架、数据库选型或安全架构设计时应当编写 ADR;而日常 Bug 修复、配置调整或 minor 版本升级则直接跳过。其次,它内置了五种模板:
- 标准
MADR格式与轻量级记录 Y-Statement与废弃记录RFC风格
覆盖从立项到下线的完整生命周期。在管理层面,技能指导你建立规范的目录结构与 README.md 索引,并通过 adr-tools 等工具实现自动化,从而构建出一张清晰的决策图谱。
适用边界与安全原则
在遵循“尽早编写、保持简短、诚实记录代价”等最佳实践的同时,本技能有严格的安全边界。它不会自动安装依赖、修改系统权限或创建持久化任务。当流程涉及发布、删除、付款等外部写入操作时,必须先展示目标与影响并取得明确确认。凭据仅用于指定的官方服务,命令和代码默认仅作参考,只有在范围清晰且用户明确授权时才会执行。
使用场景
- 引入微服务架构前,记录采用该方案的背景与潜在风险。
- 接手历史项目时,查阅过往记录以理解数据库选型的历史原因。
- 为团队制定统一的架构决策编写规范与评审流程。
- 下线旧版 API 时,撰写废弃记录并说明迁移路径。
适合人员
- 后端架构师,需要为团队的技术选型提供标准化的文档支撑。
- 新入职的开发工程师,期望快速理解项目的历史技术背景。
- 技术项目经理,负责制定和维护工程团队的决策流程。
- 技术布道师,希望在组织内推广规范化的架构文档实践。