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.

Escriba comentarios de código claros y sencillos y documentación que conviva con el código. Úselo al escribir o revisar código que necesita documentación en línea, como encabezados de archivos, documentos de funciones, decisiones arquitectónicas o comentarios explicativos. Funciona bien tanto para lectores humanos como para asistentes de codificación de IA que ven un archivo a la vez. Fuente: petekp/agent-skills.

Ver original