Skip to content

DocumentationContentStructure

DavidFreely edited this page Nov 7, 2025 · 45 revisions

Related: DocumentationPage

A) Title (DocumentationTitles)

B) /Related-Section

If a link is wished but there is no fitting text to put the link to.

Helps to still have the whole picture. (Linked Notes).

C) Content

Good Structure:

Minimal mental capacity for finding what one wants to find.

  • Small but linked (Linked Notes)
  • Sorted alphabetically
  • Text > Symbols (for clarity)

Typical Elements:

  • Link
    • external ([LINKNAME](URL))
    • internal ([[PAGETITLE]])
  • List
  • Picture
  • Sections
    • Header2 (## ), Header3 (### ), ..
  • Sequence
    • Example: A) .. B) .. C) ..
  • Text

Clone this wiki locally