アーキテクチャ決定記録(ADR)テンプレート

これは EdgeX Foundry の ADR のためのテンプレートです。

出典: https://docs.edgexfoundry.org/2.3/design/adr/template/

提出者

ADR の提出者を列挙します。

形式:

• 名前(組織)

変更履歴

状態、日付、PR の URL を含め、文書への変更を列挙します。

状態は次のいずれかです: pending、approved、amended、deprecated。

日付は ISO 8601(YYYY-MM-DD)の文字列です。

PR は、diff、貢献者、レビュー担当者などの情報を含む、変更を提出したプルリクエストです。

形式:

• [ADR の状態(例: approved、amended など)](プルリクエストの URL) YYYY-MM-DD

参照するユースケース

関連するすべてのユースケース/要件文書を列挙します。

ADR には、少なくとも 1 つの関連する承認済みのユースケースが必要です。

形式:

• [ユースケース名](URL)

ADR がユースケースのすべての要件に対処していない場合は、説明を追加します。

コンテキスト

次を記述します:

• 設計がアーキテクチャ上どのように重要で、ADR が必要なのか(問題を修正するための単純な課題と PR ではなく)

• 高レベルの設計アプローチ(詳細は下記の提案設計に記述)

提案設計

設計の詳細(可能な限り実装には踏み込まない)。

概要:

• 影響を受ける(変更される)サービス/モジュール

• 追加される新しいサービス/モジュール

• モデルと DTO への影響(変更/追加/削除)

• API への影響(変更/追加/削除)

• 一般的な設定への影響(新しいセクションの設置、変更/追加/削除)

• devops への影響

検討事項

ADR の議論で生じた代替案、懸念、付随的または関連する課題、質問を文書化します。

それらが解決または緩和されたかどうか、またどのように解決または緩和されたかを示します。

決定

合意された重要な実装の詳細、注意事項、将来の検討事項、残っている、または延期された設計上の課題を文書化します。

提案設計で満たされない要件の部分を文書化します。

その他の関連 ADR

機能のサブコンポーネントに関する設計決定、この設計の結果として廃止された設計など、関連する ADR を列挙します。

形式:

• [ADR のタイトル](URL) - 関連性

参考文献

追加の参考文献を列挙します。

形式:

• [タイトル](URL)