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?" |

Rédaction d'une documentation logicielle claire et découvrable selon le cadre Eight Rules et Diataxis. À utiliser lors de la création de fichiers README, de documents API, de didacticiels, de guides pratiques ou de toute documentation de projet. Applique automatiquement les documents/emplacements, les exigences de liaison et les exemples exécutables. Source : nilecui/skillsbase.

Voir l'original