Zum Inhalt

Aufbau

Seite

Anfang

Am Anfang der Seite kann ein Meta-Block eingefügt werden. Dies verbessert das Suchergebnis und die Darstellung in Suchmaschienen.

Beim Schreiben der Dokumentation (snapshot) kann eine Tasklist zur Strukturierug der Aufgaben verwendet werden. In einer fertigen Dokumentation sollten keine Tasklist eingefügt werden.

Eine Seite einer Dokumentation besitzt immer eine und nur eine Überschrift erster Ordnung # Überschrift. Der Titel sollte mit dem Navigationspunkt übereinstimmen oder diese sinnvoll ergänzen.

Hauptteil

Der Text der Seite kann durch Abschnitte mit Überschriften zweiter Ordnung gegliedert werden.

Die Dokumentation sollte mit Bildern und UML-Diagrammen angereichert werden. Dies hilft den Inhalt besser rüberzubringen.

Für Entwicklerdokumentationen können Codebeispiele hilfreich sein.

Abschluß

Am Ende einer Seite können Fragen und Antworten in einer Hinweisbox vom Type question hinzugefügt werden. Die Fragen sind Fett zu setzen.

!!! question "FAQ"

    **Was bedeutet FAQ?**  

    FAQ bedeutet Fragen und Antworten  

    **WAS bedeutet Q&A?**

    Q&A steht für Question & Answer

FAQ

Was bedeutet FAQ?

FAQ bedeutet Fragen und Antworten

WAS bedeutet Q&A?

Q&A steht für Question & Answer

Ein weitere Abschlußblock können Referenzen (als Verweise auf andere Dokumente) sein.

## Referenzen

* [1. Titel](Link auf Referenz)
* [2. Titel](Link auf Referenz)