Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleSections
Section
titleDescription

Provide an overview over the information on this document. Readers may decide on this description if the document contains relevant information to them.

Section
titleSummary

Provide a summary of the documents structure and key points. This is an informative abstract typically of about 100 to 200 words.

Section
titleRequirements Overview

Provide an overview over the most important functional requirements.

More help to document requirements in this overview is found on arc42 on GitHub.

 

Source: arc42 on GitHub

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing projectdoc

Typically you add documents of type Requirement to the homepage of requirements and then reference the most important ones with the Display Table Macro.

Alternatively you may use the Tour Macro and reference the requirement documents individually.

In either case you typically do not attach the requirement documents as children to this document. The requirements and therefore their descriptions exist without the need of the existence of this document. This document is only a view, albeit an important one.

You may also create a Section document and attach this as a child to this document. Section documents share the lifespan of the parent and are removed with them. If you use a section document, the requirement overview may be easier to reference if requested. The document can be edited independently of other information. Typically is depends on the amount of information specified, if a separate document is advisable.

Source:

More help to document quality goals in this overview is found on arc42 on GitHub.

Section
titleQuality 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.

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing projectdoc

Typically you add documents of type Quality Target to the homepage of quality targets and then reference ones with the highest priority with the Display Table Macro.

Alternatively you may use the Tour Macro and reference the quality target documents individually.

In either case you typically do not attach the quality target documents as children to this document, for the same reasons as given for the requirements.

The same reasons for creating a subordinate document exist as for the requirement overview.

Source:

More help to document stakeholders in this overview is found on arc42 on GitHub.

Section
titleStakeholders

List of the most important persons or organizations that are affected by can contribute to the architecture.

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing projectdoc

Typically you add documents of type Stakeholder to the homepage of stakeholders and then reference those with an impact on the architecture with the Display Table Macro. You may also want to reference Roles in case there is no single stakeholder to reference.

Alternatively you may use the Tour Macro and reference the quality target documents individually.

In either case you typically do not attach the quality target documents as children to this document, for the same reasons as given for the requirements.

The same reasons for creating a subordinate document exist as for the requirement overview.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...