agentic-docs

SKILL.md

Write documentation that lives with the code it describes. Plain language. No jargon. Explain the why, not the what.

Co-location wins. Documentation in separate files drifts out of sync. Comments next to code stay accurate because they're updated together.

The "why" test: Before writing a comment, ask: "Does this explain why this code exists or why it works this way?" If it only restates what the code does, skip it.

Rédigez des commentaires de code clairs et explicites et une documentation qui accompagne le code. À utiliser lors de l'écriture ou de la révision de code nécessitant une documentation en ligne telle que des en-têtes de fichiers, des documents de fonction, des décisions architecturales ou des commentaires explicatifs. Fonctionne bien pour les lecteurs humains et les assistants de codage IA qui voient un fichier à la fois. Source : petekp/claude-code-setup.

Voir l'original