Documentation

Definition: Architecture Decision Record from where you should specialise the ADR SBBs regarding the Documentation

Source: ISO/IEC/IEEE 42010:2022

Source reference: https://www.iso.org/standard/74393.html

Additional information: This ADR documents decisions regarding the documentation practices for the software system. It includes decisions on the types of documentation to be maintained (e.g., system architecture, API documentation, user guides), tools to be used for documentation, and guidelines for keeping documentation up to date.

Example: Title: Documentation Architecture Decision Record (ADR)

LOST view: Digital Solution Architecture Decisions Catalogue view

Identifier: http://data.europa.eu/dr8/egovera/DocumentationGoal

EIRA traceability: eira:DigitalSolutionArchitectureDecisionGoal

ABB name: egovera:DocumentationGoal

EIRA concept: eira:ArchitectureBuildingBlock

Last modification: 2023-07-06

dct:identifier: ADR-20230606091024761

dct:title: Architecture Decision Record about Documentation

eira:adr_context: The context explains why we need to make a decision. It also describes the alternatives along with the pros and cons.

eira:adr_decision: The decision describes the justification for why the particular solution was accepted. It has more emphasis on the why rather than the how.

eira:adr_status: [Proposed (under review)|Accepted (approved and ready for implementation)|Superseded (superseded by another decision)]

eira:adr_consecuences: The consequences section contains information about the overall impact of an architectural decision. Every decision has trade-offs. That’s why it’s crucial to include the analysis to provide a clear picture.