用了半年Claude Code,我发现一个被严重低估的能力:它能帮你写文档,而且写得比你好

6 阅读3分钟

用了半年 Claude Code,我发现一个被严重低估的能力:它能帮你写文档,而且写得比你好。

不是那种生成一堆废话的"AI文档",而是真正能看、能用的技术文档。

先说痛点

大家有没有这种经历:

  • 项目写了三个月,README 还是最初创建时的那一行 # my-project
  • 接手同事的代码,看不懂,问人又不好意思
  • 上线了要交付文档,打开编辑器大脑一片空白
  • 写了两个小时文档,自己回头看都觉得像废话

说实话,写文档这事,对大多数程序员来说就是「知道该写但就是不想写」。不是不会,是烦。

我是怎么解决的

几个月前开始用 Claude Code,一开始只是拿它写代码。后来发现一个骚操作:用 Skills(技能模块)让它专门负责文档。

什么是 Skills?简单说就是一个 SKILL.md 文件,里面定义了 Claude 的"岗位说明书"——告诉它什么时候该干嘛、怎么干、输出什么格式。

我写了一套中文专属的文档技能,今天分享三个最实用的:

1. zh-readme:README 生成器

你有没有发现,很多开源项目的 README 特别好看?有 badge、有安装指南、有截图、有结构清晰的目录。但自己写的时候,打开 markdown 编辑器就卡壳了。

这个 skill 的工作方式是:

# 把技能装上
cp -r skills/zh-readme ~/.claude/skills/

# 然后对 Claude 说:
"帮我生成 README"

它会自动扫描你的项目结构,识别技术栈,生成一个包含以下内容的 README:

  • 项目简介(根据代码自动生成,不是瞎编)
  • 安装和运行步骤
  • 项目结构说明
  • API 文档(如果有的话)
  • 贡献指南

关键是,生成的内容是基于你实际的代码,不是模板套话。

2. zh-docgen:技术文档生成器

这个更猛。丢给它一个项目目录,它能输出:

  • 项目架构图(Mermaid 格式,可以直接渲染)
  • 模块说明文档
  • 函数/接口文档(从代码注释和签名自动提取)
  • 快速上手指南

我试过给它一个 2000 行的 Python 项目,3 分钟就生成了一份完整的中文技术文档。质量嘛,80 分有的,剩下 20 分需要自己润色,但比起从零开始写,效率提升不是一点半点。

3. changelog-gen:变更日志生成器

发版的时候要写 CHANGELOG,但谁会记得上个版本改了什么?

这个 skill 直接读你的 git log,按 Conventional Commits 规范自动分类:

✨ 新功能:新增用户导出功能
🐛 修复:修复登录超时问题  
📝 文档:更新 API 文档
⚡ 性能:优化数据库查询,响应时间降低 40%

一条命令搞定,再也不用翻 commit 历史了。

实际效果

我拿了一个真实项目测试:

不用 Skills: 写一份基础文档花了 2 小时,还不满意 用 Skills: 3 分钟生成初稿,30 分钟润色,完成

效率提升了 4 倍,而且文档质量更稳定(因为 AI 不会偷懒少写关键信息)。

怎么装?

整个项目有 18 个原创 Skills,不只是文档,还有代码审查、安全审计、API 测试、Git 工作流自动化等等。

# 一键安装全部
git clone https://github.com/laolaoshiren/claude-code-skills-zh.git
cp -r claude-code-skills-zh/skills/* ~/.claude/skills/

国内访问 GitHub 慢的话有镜像,README 里写得很清楚。

项目地址:github.com/laolaoshire…

最后说两句

Claude Code Skills 这个东西,我觉得很多人还没意识到它的价值。它不是什么复杂的框架,就是一个 markdown 文件,但就是这个简单的机制,让 AI 从"通用助手"变成了"你的专属专家"。

文档这件事,真的不需要痛苦。让 AI 来写初稿,你来把关,各取所长。

你平时用什么方式写文档?有没有更好的方案?评论区聊聊 👇