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.

編寫清晰、通俗易懂的代碼註釋和與代碼一起存在的文檔。在編寫或審查需要內聯文檔（如文件頭、函數文檔、架構決策或解釋性註釋）的代碼時使用。非常適合一次查看一個文件的人類讀者和人工智能編碼助理。 來源：petekp/agent-skills。

查看原文