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.

코드와 함께 제공되는 명확하고 평이한 코드 주석과 문서를 작성하세요. 파일 헤더, 함수 문서, 아키텍처 결정 또는 설명 주석과 같은 인라인 문서가 필요한 코드를 작성하거나 검토할 때 사용합니다. 한 번에 하나의 파일을 보는 인간 독자와 AI 코딩 보조자 모두에게 적합합니다. 출처: petekp/agent-skills.

원본 보기