zh-readme · diff
git:20260422.5e84c60 to git:20260422.d235c06
2 added, 0 removed. Audit A to A.
---
name: zh-readme
description: 中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README
---
# 中文 README 生成器
## 触发条件
当用户要求写 README、重写项目介绍、补全文档首页、优化开源仓库展示页时激活此技能。
## 核心原则
1. 先读代码和目录，再写 README；不要只凭项目名猜功能。
2. 面向中文开发者表达，技术名词保留英文，解释用自然中文。
3. 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。
4. 优先给出真实命令、真实路径、真实示例，少写空泛宣传语。
5. 如果项目已有 README，先保留有效信息，再补全缺失结构。
+ 6. 如果项目包含官网或文档站，README 中必须给出统一、可点击的正式入口链接，避免 README / 官网 / Issue 模板地址不一致。
+ 7. 项目介绍页要尽量补上社交证明信号（如 Star、精选数量、更新时间、代表性场景），帮助访客快速判断是否值得继续浏览。
## 推荐结构
```markdown
# 项目名称
> 一句话价值主张，告诉用户“这东西解决什么问题”
[](link)
[](link)
[](link)
## ✨ 项目亮点
- 亮点 1：解决什么痛点
- 亮点 2：与同类方案相比优势是什么
- 亮点 3：适合谁使用
## 📦 安装
```bash
pip install xxx
# 或 npm install / go install / cargo install
```
## 🚀 快速开始
```bash
xxx init
xxx run
```
## 🧭 使用示例
```python
from xxx import yyy
```
## 📁 项目结构
- `src/`：核心实现
- `tests/`：测试
- `docs/`：扩展文档
## ❓ 适用场景
- 场景 1
- 场景 2
- 场景 3
## 🛠️ 开发
```bash
make test
make lint
```
## 🤝 贡献
欢迎 PR / Issue。
## 📝 License
MIT
```
## 工作流程
1. 检查项目结构、包管理文件、入口文件、测试目录和已有文档。
2. 提炼项目定位：目标用户、核心能力、和替代方案相比的差异点。
3. 优先补全“安装 / 快速开始 / 使用示例 / 项目结构 / 开发方式”。
4. 如果缺少真实命令，基于仓库中的 `package.json`、`pyproject.toml`、`Makefile`、`Cargo.toml` 等提取。
5. 用中文重写标题、摘要和亮点，避免“强大、优雅、现代化”这类空词。
6. 最后检查 README 是否能支持首次访问者在 30 秒内理解并开始使用。
## 输出要求
- 默认使用 Markdown。
- 标题层级清晰，emoji 适量，不要堆砌。
- 示例命令必须可复制。
- 如果信息不足，显式标注“待补充”，不要编造不存在的特性。
## 自检清单
- 是否说明了项目解决的问题？
- 是否给出最短可运行示例？
- 是否覆盖安装、使用、贡献、License？
- 是否避免了 AI 腔和空泛营销语？
- 是否让中文开发者一眼看懂？