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.

Source:

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

Section
titleLocal Building Blocks

List the root building blocks of your system.

Expand
titleExpand for detailed information from https://github.com/arc42
Tip Box
titleUsing 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.

Section
titleDependencies and Relationships

Explain the dependencies and relationships of the listed building blocks.

Tip Box
titleUsing 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.

Transclusion
documentDocument Sections
idsstandard-sections-bottom

...