Standard für Dokumentationssysteme

Es gibt ein Geheimnis, das man verstehen muss, um eine gute Software-Dokumentation zu schreiben: Es gibt nicht eine Sache, die man Dokumentation nennt, sondern vier.

Quelle: https://documentation.divio.com/

Alle Notizen in dieser Knowledgebase werden diesen vier Typen zugeordnet: tutorial, howto, explain, reference

In eigenen Worten sind die Typen wie folgt zu verstehen:

• tutorial: Die Notiz ist eine Anleitung für ein Tool oder System.
• explain: Die Notiz beschreibt ein Begriff oder Konzept.
• howto: Die Notiz unterstützt das Troubleshooting oder gibt Anweisungen.
• reference: Die Notiz enthält Listen, Flowcharts, Tabellen oder führt nach Extern.