The blueprint of the arc42 Template creates a tree of pages in the Confluence space.
For more information on the arc42 Template, please visit its homepage at arc42.org!
arc42 is owned by
Dr. Peter Hruschka & Dr. Gernot Starke
The arc42 Template provides detailed information about the architecture of the system. The template is the central document for the system or software architecture description. It creates the software architecture documentation (SWAD) which is organized in chapters.
By following the defines layout, teams have an easier task organizing the information according to their architecture. Using the same approved structure for all projects lowers the amount of work and therefore increases productivity.
1. Launch the page wizard
2. Create the SWAD based on the arc42 Template
3. The SWAD with subdocuments for each chapter - ready to start documenting!
Properties
The document type swad provides the following properties:
Overview
The property refers to an overview document that contains a subset of information from the software architecture documentation.
Alternative View
A reference to a view on the software architecture documentation with all chapters on a single long page. This is an alternative view to the on on this page where the chapters are only referenced.
Sections
Description
Provide an overview over the information on this document. Readers may decide on this description if the document contains relevant information to them.
Summary
Provide a summary of the documents structure and key points. This is an informative abstract typically of about 100 to 200 words.
Chapters
The list of chapters of the arc42 Template.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
Chapters
The chapters of the arc42 Template.
Resources
More information on the arc42 Template is available on its original homepages.
