documentation-standards

SKILL.md

Universal principles for effective documentation. Language-agnostic—focus on what and when to document, not syntax.

Prefer clear names and simple structure over comments. Write comments for reasoning, not restating.

Rule: If you need a comment to explain what code does, refactor first.

應用文檔標準：評論為什麼而不是什麼，最少的評論（更喜歡清晰的代碼），通過快速啟動維護自述文件，通過重大更改更新文檔。在撰寫評論、創建文檔、審閱文檔或討論要記錄的內容時使用。 來源：phrazzld/claude-config。

查看原文