Architecture Decision Record

Active theme: Light

← ドキュメント

良い ADR を書くための提案

良い ADR の特徴:

  • 根拠: その特定の AD を行う理由を説明します。これには、コンテキスト(下記参照)、さまざまな選択肢の長所と短所、機能の比較、コスト/便益の議論などが含まれます。

  • 具体的: 各 ADR は 1 つの AD について書くべきで、複数の AD を扱うべきではありません。

  • タイムスタンプ: ADR 内の各項目がいつ書かれたかを明記します。これは、コスト、スケジュール、スケーリングなど、時間とともに変化する可能性のある側面にとって特に重要です。

  • 不変: ADR 内の既存の情報を変更しないでください。代わりに、新しい情報を追加して ADR を修正するか、新しい ADR を作成して ADR を置き換えてください。

ADR の良い「コンテキスト」セクションの特徴:

  • 組織の状況とビジネス上の優先事項を説明します。

  • チームの社会的構成やスキル構成に基づく根拠と考慮事項を含めます。

  • 関連する長所と短所を含め、それらをニーズや目標に沿った言葉で説明します。

ADR の良い「結果」セクションの特徴:

  • 決定を行った結果として何が起こるかを説明します。これには、影響、成果、出力、フォローアップなどが含まれます。

  • 後続の ADR に関する情報を含めます。ある ADR がさらなる ADR の必要性を引き起こすことは比較的よくあります。たとえば、ある ADR が大きな包括的な選択を行い、それがさらに小さな決定の必要性を生み出す場合などです。

  • 事後レビューのプロセスを含めます。チームが各 ADR を 1 か月後にレビューし、ADR の情報を実際に起きたことと比較して、学び成長することは一般的です。

新しい ADR は以前の ADR に取って代わることがあります:

  • 以前の ADR に取って代わる、またはそれを無効にする AD が行われた場合は、新しい ADR を作成する必要があります