Diátaxis Framework
Details
- Vollständiger Name
-
Diátaxis Dokumentations-Framework nach Daniele Procida
Kernkonzepte:
- Vier Dokumentationstypen
-
- Tutorials
-
Lernorientiert, Lektionen für Anfänger
- How-to-Guides
-
Aufgabenorientiert, Anleitungen für spezifische Ziele
- Referenz
-
Informationsorientiert, technische Beschreibungen
- Erklärung
-
Verständnisorientiert, konzeptionelle Diskussionen
- Zwei Dimensionen
-
-
Praktisch vs. Theoretisch
-
Aneignung (Lernen) vs. Anwendung (Arbeiten)
-
- Separation of Concerns
-
Jeder Typ dient einem eigenen Zweck
- Nutzerbedürfnisse
-
Verschiedene Nutzer benötigen verschiedene Dokumentation zu verschiedenen Zeiten
- Qualitätskriterien
-
Jeder Typ hat spezifische Qualitätsindikatoren
- Systematischer Ansatz
-
Framework zur Organisation jeglicher Dokumentation
- Schlüsselvertreter
-
Daniele Procida
Wann zu verwenden:
-
Organisation technischer Dokumentation
-
Verbesserung bestehender Dokumentation
-
Planung von Dokumentationsstruktur
-
Bewertung von Dokumentationsqualität
-
Ergänzung von Docs-as-Code-Ansätzen
Aktueller Stand:
-
Der Vier-Quadranten-Kern (Tutorials, How-to Guides, Reference, Explanation) ist stabil; diataxis.fr ist eine lebende, unversionierte Site — laut Kolophon wird das Werk "weiter ausgearbeitet und erkundet"
-
Die Site ist um den Kern herum gewachsen: ein Theorieteil (Map, Foundations, Quality) und neuere Praxis-Anleitung wie "Diátaxis in complex hierarchies" — ein auf den älteren Divio-Artikel (2014–2021) geankerter Prior verpasst diese Verfeinerungen und die Stellen, an denen Procida seine frühere Darstellung inzwischen revidiert hat