Software Architecture: Documentation

Описание: Intent The section points out the purpose of this view and the list of the architectural drivers addressed by this view provide the intent
of the view.
Context. The section defines or references the larger part of the designed solution within which this view exists and the external systems and actors related to this view.
Representation. The section defines and depicts the design decisions made to address the intent in the specified context. It includes a diagram visualizing the decisions made.
Elements. The section lists the elements defined in the view defining their types, responsibilities, semantics, constraints, properties, relationships, and other important traits.
Contracts. The section defines important element interfaces and integration points in as much detail as needed to enforce the clear contracts between elements and other subsystems.
Behavior. The section shows dynamic aspects of the defined structures using UML sequence, communication, state machine, and activity diagrams, scenarios, and other means.
Variability. The section documents planned configuration, customization, and substitution options to implement change requests, deploy, integrate, and do other operations.
Reasoning. The section reasons about the decisions described in the view. It can also document the alternative decisions and compare them to the accepted ones.


Resources:
https://www.amazon.com/Documenting-So...
Designing Software Architectures: A Practical Approach (SEI Series in Software Engineering) 1st Edition
https://www.amazon.com/Applying-UML-P...
https://arc42.org/
https://www.iso.org/obp/ui/#iso:std:i...
TOGAF Architecture Development Method (ADM)
https://c4model.com/

#SoftwareArchitecture #SolutionsArchitecture #SoftwareArchitectureDocumentation #ADD