documentation-writing

SKILL.md

Creates high-quality, discoverable documentation following the Eight Rules and Diataxis framework. Ensures all docs are properly located, linked, and contain real runnable examples.

| Type | Purpose | Location | User Question |

| Tutorial | Learning | docs/tutorials/ | "Teach me how" | | How-To | Doing | docs/howto/ | "Help me do X" | | Reference | Information | docs/reference/ | "What are the options?" | | Explanation | Understanding | docs/concepts/ | "Why is it this way?" |

Verfassen einer klaren, auffindbaren Softwaredokumentation gemäß dem Acht-Regeln- und Diataxis-Framework. Verwenden Sie diese Option, wenn Sie README-Dateien, API-Dokumente, Tutorials, Anleitungen oder Projektdokumentationen erstellen. Erzwingt automatisch Dokumente/Speicherort, Verknüpfungsanforderungen und ausführbare Beispiele. Quelle: rysweet/amplihack.

Original anzeigen