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
titleTerms

The list of selected glossary items that are relevant for the understanding of the software architecture.

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

Tip Box
titleUsing projectdoc

The terms of the domain are typically documented using the Glossary Item doctype.

Use the Transclude Documents Macro to transclude from these documents according to the information needs of your stakeholders.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...