ADR
Architecture Decision Records
アーキテクチャ上の設計判断と意思決定の履歴を、テキストベースの軽量なテンプレートを使用して記録するもの 享受できるメリット
設計判断をチームの責任において記録できる
重要な設計判断をリポジトリに保存することで、コードに近い場所に置いておける
他の生成物と組み合わせて、全体的な説明戦略を作成できる
歴史を記録することで、設計の進化に関する展望を得られる
チーム全体を設計プロセスに巻き込める
ADRテンプレートを提供することで、チームメンバーのアーキテクチャ思考を訓練できる
標準の開発発ツールと既存のピアレビューワークフローを使って、設計判断をピアレビューできる
テンプレ
code:md
# Title
## Status
Draft (📝) / Proposed (🙋♀️) / Rejected (🙅) / Accepted (👍) / Deprecated (💥)
## Decision
決めたことについて書く
## Context
Decision に至る背景情報など
## Consideration
比較・検討した内容について書く
## References
参考リンクなど
例
カジュアルに書けるのが最重要なので、Github Discussionsを活用するとよさそう
参考