Doc As Code

Utiliser Typedoc/Sphinx et maintenir README/CONTRIBUTING. Use this skill whenever the user asks about doc as code in an open-source maintenance context — including phrasing like "générer la documentation", "mettre à jour le readme", "maintenir la doc à jour" — even if they don't name the skill directly.

Tryboy869 150948a 898 B Updated

File contents

Quand invoquer ce skill

Utiliser Typedoc/Sphinx et maintenir README/CONTRIBUTING.

L1 — Réflexe de base

Maintenir un README à jour avec install, usage, licence.

L2 — Pratique professionnelle par défaut

Générer la doc API depuis les commentaires du code (Typedoc/Sphinx/JSDoc) pour qu'elle ne diverge jamais du code.

L3 — Maîtrise d'architecte

Documentation versionnée en parallèle des releases, CONTRIBUTING.md incluant le workflow de rebase/PR attendu, CI qui échoue si la doc publique n'est pas régénérée.

tryboy869/opf/tree/main/skills/technical-excellence/doc-as-code commit 150948a2ef

Frequently asked questions

npx skillmds@latest add tryboy869/doc-as-code