skill-README-writer
by @justzerox
为本地项目或 GitHub 项目生成专业的 README.md 文档。**触发词："写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"**。支持自动收集项目信息、交互式确认、中英双语。根据项目类型（Python/前...
clawhub install skill-readme-writer📖 About This Skill
name: README-writer description: 为本地项目或 GitHub 项目生成专业的 README.md 文档。触发词："写 README"、"生成 README"、"README.md"、"项目文档"、"GitHub 文档"、"readme"、"项目介绍"、"文档生成"。支持自动收集项目信息、交互式确认、中英双语。根据项目类型（Python/前端/Skill/CLI 等）生成对应的专业文档。
README Writer - 项目文档生成器
📝 为本地项目或 GitHub 项目生成专业的 README.md 文档
采用交互式工作流程：自动收集信息 → 用户确认 → 生成目录 → 用户确认 → 生成 README → 迭代优化
🎯 何时使用（触发场景）
✅ 使用此技能当用户说：
| 场景 | 示例 | |------|------| | 本地项目 | "为这个项目写 README：~/.openclaw/skills/my-project" | | GitHub 项目 | "给 https://github.com/user/repo 写 README" | | Skill 项目 | "为 easy-image-generate 写 README" | | 优化现有 | "优化这个项目的 README" | | 指定风格 | "参考 skill-rembg 风格写 README" |
❌ 不使用此技能：
🔄 交互式工作流程
完整流程（11 步）
1. 用户输入（本地路径或 URL） 2. 自动收集项目信息 3. 展示信息，用户确认/修改 4. 询问 README 目的和风格偏好 5. 生成建议目录结构 6. 用户确认/调整目录 7. 💬 可选章节询问（致谢/贡献/更新日志） 8. 生成 README 草稿 9. 质量检查 + 用户反馈 10. 迭代优化（可多次） 11. 最终版本 + 备份
📊 第 1 步：项目信息收集
本地项目
自动读取：
展示给用户确认：
📊 检测到项目信息：
基本信息：
项目类型： [自动识别]
核心功能： [自动分析]
以上信息是否正确？需要补充或修改吗？
🎯 第 2 步：询问 README 目的
询问模板：
🎯 这个 README 的主要读者是谁？
A. 潜在用户 - 快速了解项目用途 B. 开发者 - 想要贡献代码 C. 两者兼顾（推荐）
📝 希望突出什么内容？
A. 快速上手 - 安装 + 使用示例 B. 功能特点 - 详细的功能列表 C. API 文档 - 技术细节 D. 项目背景 - 为什么创建这个项目
🎨 文档风格偏好？
A. 简洁专业 - 像 requests 库 B. 活泼友好 - 像 skill-rembg（emoji+ 双语） C. 详细完整 - 像大型框架
📑 第 3 步：生成目录结构
根据项目类型和偏好生成建议目录结构，用户确认后再继续。
💬 第 3.5 步：可选章节询问
必须询问的章节：
📝 需要添加以下章节吗？
1️⃣ 致谢部分（🙏 Acknowledgements）
感谢贡献者、使用的工具或平台
请回复：
2️⃣ 贡献指南（🤝 Contributing）
如何为项目贡献代码
请回复：
3️⃣ 更新日志（📝 Changelog）
项目版本历史
请回复：
规则：
✍️ 第 4 步：生成 README 草稿
生成规则
#### 0. Badge 区域（项目简介后）
🎨 采用多行专业布局（丰富完整，用户可手动精简）：
💡 设计理念：
author、repo、skill-name）📋 Badge 动态生成规则
#### Row 1: 核心信息 Badge（项目身份）
1. ClawHub Badge
SKILL.md）name 字段读取，转换为 kebab-casehttps://clawhub.ai/author/skill2. GitHub Badge
.git 目录https://github.com/author/repo3. Version Badge（必须生成）
package.json → version
2. pyproject.toml → version
3. Cargo.toml → version
4. pom.xml → version
5. composer.json → version
6. 默认：0.0.1
#### Row 2: 包管理器 Badge（如已发布）
根据项目类型生成对应的包管理器 Badge：
| 项目类型 | Badge | 链接 |
|---------|-------|------|
| npm 包 |  | npmjs.com |
| Python 包 |  | pypi.org |
| Ruby Gem |  | rubygems.org |
| Go Module |  | pkg.go.dev |
| Maven |  | search.maven.org |
链接处理：如无法获取实际包名，使用 Demo 占位符
#### Row 3: 技术栈/语言版本 Badge
自动读取项目配置生成：
Node.js 项目（读取 package.json → engines.node）：
Python 项目（读取 pyproject.toml 或 setup.py → python_requires）：
Rust 项目（读取 Cargo.toml → edition）：
Go 项目（读取 go.mod → go 版本）：
PHP 项目（读取 composer.json → require.php）：
链接处理：使用官方文档链接或 Demo 占位符
#### Row 4: 平台 Badge（全部生成，用户可精简）
默认生成所有平台 Badge，用户可根据实际情况手动删除：
颜色规范：
#000000（黑）#0078D6（蓝）+ Base64 SVG Logo#FCC624（黄）#3DDC84（绿）#000000（黑）#4285F4（蓝）链接处理：使用 Demo 占位符 https://openclaw.ai
#### Row 5: License Badge
读取优先级：
1. package.json → license
2. pyproject.toml → license
3. Cargo.toml → license
4. LICENSE / LICENSE.md / LICENSE.txt 文件名
5. 默认：MIT
License 颜色映射：
#BD2D2D（红）#D54D2D（橙红）#FF7A00（橙）#3B82F6（蓝）#10B981（绿）#6B7280（灰）#6B7280（灰）格式：
链接处理：指向 LICENSE 文件（如不存在，用户可手动修改）
✅ Badge 生成示例（完整版）
#### 示例：Node.js 项目（完整 Badge 展示）
💡 提示用户：在 README 末尾添加说明：
> 💡 Badge 说明：以上 Badge 为自动生成，如与实际不符可手动删除或修改。
⚠️ Badge 生成规则总结
author、repo、skill-name）#### 1. 中英双语规则
中文部分：
English Version：
章节对应规则：
## 标记主章节### 标记主章节### Table of Contents 标记 标记#### 2. 代码块格式
所有代码块使用 ` 标记
格式：
`语言
代码内容
规则：
#### 3. 可选章节
根据第 3.5 步的用户确认结果生成：
#### 4. 其他规则
🔄 第 5 步：迭代优化
支持多次迭代，根据用户反馈修改 README。
📋 特殊场景处理
场景 1：已有 README
⚠️ 检测到已有 README.md
选项： A. 完全重写（覆盖现有） B. 基于现有优化（保留结构，改进内容） C. 生成新版本（README.new.md）
场景 2：多语言项目
🌍 检测到多语言项目
建议： A. 生成独立的 README_CN.md 和 README_EN.md B. 在主 README 中分章节（中文 | English）
场景 3：大型项目
📊 检测到大型项目（>50 文件）
建议：
🎨 README 风格指南
核心原则
1. 结构清晰 - emoji 标记章节，层级分明 2. 中英双语 - 默认中文 + English version，内容完整一致 3. 实用优先 - 根据项目类型调整 4. 灵活发挥 - 根据项目特点自由组织
项目类型特定内容
| 项目类型 | 特有章节 | 说明 | |----------|---------|------| | Python | 依赖安装、虚拟环境、PyPI 发布 | requirements.txt, setup.py | | 前端 | 技术栈、构建命令、部署指南 | package.json, npm scripts | | API 服务 | 端点列表、请求示例、认证方式 | REST/GraphQL, curl 示例 | | CLI 工具 | 命令行参数、子命令、配置选项 | 参数说明，使用示例 | | 库/SDK | API 参考、类型定义、版本兼容性 | 函数/类说明，类型提示 | | OpenClaw Skill | 触发词、使用场景、配置 | SKILL.md 内容提取 |
✅ 质量检查清单
生成 README 后自动检查：
基础检查
中英双语检查
可选章节检查
Badge 检查（新增）
）代码块检查
标记（无 ~~~）禁止项
📝 版本管理
备份策略
生成前备份现有 README：
cp README.md README.md.bak.日期
版本记录
在 README 末尾添加更新日志章节。
🔧 配置选项
语言设置
| 参数 | 说明 | 默认 |
|------|------|------|
| --lang bilingual | 中英双语 | ✅ |
| --lang chinese | 仅中文 | - |
| --lang english | 仅英文 | - |
详细程度
| 参数 | 章节 | 适合 |
|------|------|------|
| --detail minimal | 简介、安装、使用 | 小型项目 |
| --detail standard | + 功能、API、贡献 | 中型项目（默认） |
| --detail complete | + FAQ、基准、架构 | 大型项目 |
风格选项
| 参数 | 说明 |
|------|------|
| --style professional | 简洁专业 |
| --style friendly | 活泼友好（emoji+ 双语） |
| --style complete` | 详细完整 |
🚀 快速上手
基础使用
为这个项目写 README：~/.openclaw/skills/my-project
指定风格
为 https://github.com/user/repo 写 README，参考 skill-rembg 风格
指定类型
为 Python 项目写 README，突出 API 文档
📄 许可证
MIT License
Happy Documenting! 📝✨