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.

明確で平易なコードコメントと、コードと一緒に存在するドキュメントを作成します。ファイル ヘッダー、関数ドキュメント、アーキテクチャ上の決定、説明コメントなどのインライン ドキュメントが必要なコードを作成またはレビューするときに使用します。一度に 1 つのファイルを閲覧する人間の読者と AI コーディング アシスタントの両方に適しています。 ソース: petekp/agent-skills。

原文を見る