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
titleExplanation

Provide a short summary and explanation of the fundamental solution ideas and strategies.

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

This is a free text section. You may have a separate Section for each idea or strategy 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 ideas and strategies 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

...