search

tmforum-oda / oda-ca-docs

ODA Component Accelerator Documents
6 stars 17 forks source link

Create a template for decisions #155

Open abbeydom opened 2 months ago

abbeydom commented 2 months ago

Description

Architecture decisions currently does not have a template. A template will standard decisions and how they are documented, we may consider using DACI if appropriate.

abbeydom commented 2 months ago

An earlier decision had been made by the ODA-CA board to use the pattern for Architecture Decision Records, as described by Michael Nygard in: http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions to document ODA Canvas architecture decisions. A reference to this decision is available at: https://github.com/tmforum-oda/oda-ca-docs/blob/master/Decision-Log/0001-record-architecture-decisions.md.

A suggestion to the agreed pattern, is to include a rationale section to capture the reasoning and thought process behind a decision. Therefore a decision record would have the following sections: Title , Status, Context, Rationale, Decision and Consequences.

@LesterThomas , @brian-burton and others please, any thoughts?