documentation
Installation
SKILL.md
Documentation (文档生成)
📝 核心理念: 好的文档是代码的延伸,让代码自己说话,让文档补充上下文。
🔴 第一原则:文档即代码
文档和代码同等重要,必须同步维护!
❌ 错误思路: "先写代码,有空再补文档"
✅ 正确思路: "代码和文档一起写,保持同步"
❌ 错误思路: "代码写得好就不需要文档"
✅ 正确思路: "代码说明 How,文档说明 Why 和 When"
文档优先级: 类型定义 > 函数注释 > README > 详细文档