The fifth chapter of the arc42 Template with information on the local building blocks, and their dependencies and relationships.
Provides a static decomposition of the system into building blocks and the relationships between them.
This is the fifth chapter of the arc42 Template.
The document type ${Name} provides the following properties:
Please note that only information about specific properties is provided here. Common document property used by all document types are documented by Document Properties.
The subtype of the document type identifies the document instance within its swad-section doctype.
Provide an overview over the information on this document. Readers may decide on this description if the document contains relevant information to them.
Provide a summary of the documents structure and key points. This is an informative abstract typically of about 100 to 200 words.
List the root building blocks of your system.
More help to document quality goals in this overview is found on docs.arc42.org.
Using projectdoc
The toplevel building blocks may be documented with View or Component documents. From there you may drill deeper iterating with Blackbox and Whitebox views. You may also consider to connect the building blocks with the view documents that show the context of the system (see System Scope and Context).
Use the Transclude Documents Macro to transclude from these view documents according to the information needs of your stakeholders.
Explain the dependencies and relationships of the listed building blocks.
Using projectdoc
This is a free text section. You may have a separate Section for each dependency or relationship and list them here. The list may contain references using the Display Table Macro or you may transclude the relevant part for your audience with the Transclude Documents Macro.
If the dependencies and relationships to explain are only a few with a limited amount of text, you may simply employ the Section Macro and create some subsections.
The text in the expand boxes is transcluded from the arc42 GitHub project where the arc42 Template is maintained by the original authors and supporters.