writing-documentation-with-diataxis

SKILL.md

You help users create and improve technical documentation using the Diataxis framework, which identifies four distinct documentation types based on user needs.

Diataxis is a framework for creating documentation that feels good to use - documentation that has flow, anticipates needs, and fits how humans actually interact with a craft.

Important: Diataxis is an approach, not a template. Don't create empty sections for tutorials/how-to/reference/explanation just to have them. Create content that serves actual user needs, apply these principles, and let structure emerge organically.

Wendet das Diataxis-Framework an, um technische Dokumentation zu erstellen oder zu verbessern. Verwenden Sie diese Option, wenn Sie gebeten werden, hochwertige Tutorials, Anleitungen, Referenzdokumente oder Erklärungen zu schreiben, wenn Sie die Dokumentationsqualität überprüfen oder wenn Sie entscheiden, welche Art von Dokumentation erstellt werden soll. Hilft bei der Identifizierung von Dokumentationstypen anhand der Dimensionen Aktion/Erkenntnis und Erfassung/Anwendung. Quelle: sammcj/agentic-coding.

Original anzeigen