The first chapter of the arc42 Template with information on requirements, quality goals, and stakeholders.
The introduction to the architecture documentation lists the driving forces that software architects must consider in their decisions. This includes on the one hand the fulfilment of functional requirements of the stakeholders, on the other hand the fulfilment of or compliance with required constraints, always in consideration of the architecture goals.
This is the first chapter of the arc42 Template.
Properties
The document type swad-section provides the following properties:
Docsubtype
The subtype of the document type identifies the document instance within its swad-section doctype.
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.
Requirements Overview
Provide an overview over the most important functional requirements.
More help to document requirements in this overview is found on docs.arc42.org.
Quality Goals
Provide an overview over the top three (max five) goals for the architecture and/or constraints whose fulfillment is of highest importance to the major stakeholders.
More help to document quality goals in this overview is found on docs.arc42.org.
Stakeholders
List of the most important persons or organizations that are affected by can contribute to the architecture.
More help to document stakeholders in this overview is found on docs.arc42.org.
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.
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.
