Claude Code 一条命令自动生成完整 README，这个 Skill 有点好用

写代码 1 小时，写 README 3 小时——这是很多工程师的真实写照。尤其是接手别人的老项目时，经常面对一份要么缺失、要么过时、要么连怎么运行都没写清楚的 README。

今天挖到一个很小但很精准的 Skill——project-readme-skill，专门解决”给任何项目生成完整 README”这个问题。

它做什么？

简单说：丢给 Claude Code 一个项目，它自动分析目录结构、识别技术栈、探测依赖环境，然后给你生成一份结构完整的 README。覆盖内容通常包括：

• 项目简介和技术栈说明
• 本地安装和运行步骤
• API 接口文档（如果有）
• 测试运行方式
• 贡献指南

支持增量更新——如果项目已有 README，它会先读一遍，再决定是补充还是重写，而不是直接覆盖。

为什么值得用？

我见过不少 AI 生成 README 的工具，大部分是”塞给 AI 一个项目名，等它瞎猜”。这个 Skill 的思路不太一样：它先扫描真实项目结构，再基于实际文件生成文档。至少不会有”项目叫电商后台，但 README 里写的是博客系统”这种尴尬。

另外它是给 Claude Code 用的，意味着你可以直接在终端里跟 AI 对话，补充你想特别说明的内容，而不是一次性全丢给 AI 自己猜。

怎么安装？

git clone https://github.com/alon-p/project-readme-skill.git
mkdir -p ~/.claude/skills
cp project-readme-skill/SKILL.md ~/.claude/skills/project-readme-skill.md

安装后在 Claude Code 里直接打：

/project-readme-skill

剩下的交给 AI。

适用场景

• 开源项目发布前需要一份像样的 README
• 接手老项目，原 README 已经过时
• 团队内部工具，想快速生成使用文档
• 想规范项目 README 结构，但懒得自己写模板

GitHub：https://github.com/alon-p/project-readme-skill

GitHub: https://github.com/alon-p/project-readme-skill