Skip to content

Latest commit

 

History

History
16 lines (12 loc) · 912 Bytes

index.md

File metadata and controls

16 lines (12 loc) · 912 Bytes

Explanation

Explanation documents are used to provide additional documentation, know how, guidelines and examples to understand the background of a specific topic.

Find out more about explanation guides at https://indoc.pro/documentation-types/explanation/ .

Elements of an Explanation document

  • Introduction: short and brief introduction
  • Theoretical knowledge: provide background information in the user's language (using images and other rich media)
  • Specific topics: describe additional areas or concepts that are relevant fo better understand the explanation topic
  • Examples: provide matching examples, so the reader better understands how to apply the concept in practice
  • Further reading: link additional guides, explanation documents and resources in the product documentation, or external reference

How-to

Reference to Explanation template in external file