diataxis

Apply the Diátaxis systematic framework to structure and write documentation.

| Action (doing) | Tutorial | How-to guide | | Cognition (thinking) | Explanation | Reference |

Write tutorials as lessons. Take the learner by the hand through a practical experience where they acquire skills by doing.

Strukturieren, klassifizieren und schreiben Sie Dokumentation mit dem Diátaxis-Framework. Verwenden Sie es beim Schreiben von Dokumenten, README-Dateien, Leitfäden, Tutorials, Anleitungen, API-Referenzen oder beim Organisieren der Dokumentationsarchitektur. Verwenden Sie es auch, wenn Sie aufgefordert werden, die Dokumentation zu verbessern, Dokumente neu zu strukturieren, zu entscheiden, welche Art von Dokument geschrieben werden soll, oder vorhandene Inhalte zu klassifizieren. Enthält Tutorials, Anleitungen, Referenzen und Erklärungen. Quelle: cachemoney/agent-toolkit.