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.

Schreiben Sie klare, klare Codekommentare und eine Dokumentation, die neben dem Code steht. Verwenden Sie es, wenn Sie Code schreiben oder überprüfen, der eine Inline-Dokumentation wie Dateikopfzeilen, Funktionsdokumente, Architekturentscheidungen oder erläuternde Kommentare benötigt. Funktioniert sowohl für menschliche Leser als auch für KI-Codierungsassistenten, die jeweils eine Datei sehen. Quelle: petekp/agent-skills.

Original anzeigen