架构决策记录 (Architecture Decision Records)
本目录包含 EasyKiConverter 项目的架构决策记录(ADR)。
什么是 ADR?
ADR(Architecture Decision Records)是一种轻量级文档,用于记录"为什么我们做了某个重要的技术决策"。它帮助我们:
- 理解项目的历史决策
- 为新决策提供上下文
- 促进团队沟通
- 避免重复讨论相同的问题
ADR 格式
每个 ADR 应包含以下部分:
- 状态:提议、已接受、已弃用、已替代
- 上下文:问题是什么?为什么需要做这个决策?
- 决策:我们决定做什么?
- 后果:这个决策的结果是什么?包括积极和消极的后果
ADR 命名规范
ADR 文件应使用以下命名格式:
例如:
- 001-mvvm-architecture.md
- 002-qt-quick-ui-framework.md
- 003-two-stage-export-strategy.md
ADR 流程
创建新 ADR
- 创建一个新的 ADR 文件,状态设为"提议"
- 在团队中讨论该决策
- 根据反馈修改 ADR
- 如果决策被接受,将状态更新为"已接受"
- 如果决策被拒绝,将状态更新为"已拒绝"
更新 ADR
如果决策发生变化:
- 更新 ADR 的内容
- 更新状态(如果需要)
- 创建新的 ADR 记录新的决策
- 在旧 ADR 中引用新的 ADR
现有 ADR
- ADR 001: 选择 MVVM 架构
- ADR 001: Choose MVVM Architecture (English)
- ADR 002: 流水线并行架构
- ADR 002: Pipeline Parallelism for Export (English)
- ADR 003: 流水线性能优化
- ADR 004: 符号库更新导出修复
- ADR 005: 流水线 Worker 微观性能优化
- ADR 006: 网络性能优化