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。
可引用信息
为搜索与 AI 引用准备的稳定字段与命令。
- 安装命令
npx skills add https://github.com/phrazzld/claude-config --skill documentation-standards- 分类
- ""沟通写作
- 认证
- ✓
- 收录时间
- 2026-02-01
- 更新时间
- 2026-02-18
快速解答
什么是 documentation-standards?
应用文档标准:评论为什么而不是什么,最少的评论(更喜欢清晰的代码),通过快速启动维护自述文件,通过重大更改更新文档。在撰写评论、创建文档、审阅文档或讨论要记录的内容时使用。 来源:phrazzld/claude-config。
如何安装 documentation-standards?
打开你的终端或命令行工具(如 Terminal、iTerm、Windows Terminal 等) 复制并运行以下命令:npx skills add https://github.com/phrazzld/claude-config --skill documentation-standards 安装完成后,技能将自动配置到你的 AI 编程环境中,可以在 Claude Code 或 Cursor 中使用
这个 Skill 的源码在哪?
https://github.com/phrazzld/claude-config
详情
- 分类
- ""沟通写作
- 来源
- skills.sh
- 收录时间
- 2026-02-01