zh-readme

1# 中文 README 生成器
2 
3## 触发条件
4当用户要求写 README、重写项目介绍、补全文档首页、优化开源仓库展示页时激活此技能。
5 
6## 核心原则
71. 先读代码和目录，再写 README；不要只凭项目名猜功能。
82. 面向中文开发者表达，技术名词保留英文，解释用自然中文。
93. 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。
104. 优先给出真实命令、真实路径、真实示例，少写空泛宣传语。
115. 如果项目已有 README，先保留有效信息，再补全缺失结构。
126. 如果项目包含官网或文档站，README 中必须给出统一、可点击的正式入口链接，避免 README / 官网 / Issue 模板地址不一致。
137. 项目介绍页要尽量补上社交证明信号（如 Star、精选数量、更新时间、代表性场景），帮助访客快速判断是否值得继续浏览。
148. README 首屏必须具备“30 秒价值判断”能力：首句价值主张 + 适合谁用 + 最短安装方式，缺一不可。
159. 如果项目带官网、Issue 模板、下载镜像或社区入口，优先整理为单一正式入口，减少用户在多个链接间来回跳转。
1610. 如存在 badge、Hero 文案、官网首页等配套渠道，README 文案要与这些渠道保持口径一致，避免承诺和数据冲突。
17 
18## 首屏优化模板
19- **一句话价值主张**：明确解决什么问题，避免“强大/优雅/现代化”之类空词。
20- **适合谁用**：点名目标用户或典型场景，例如“面向中文开发者”“适合团队协作”“适合零配置上手”。
21- **最短安装方式**：给出一段可直接复制的命令，优先放 GitHub 原生地址；如有镜像，再作为补充。
22- **统一入口**：官网、文档、Issue 征集、下载方式尽量收敛到 1 个正式入口，减少用户决策成本。
23- **社交证明**：在不堆砌数据的前提下，展示 star、精选数量、更新时间或代表性案例。
24 
25## 推荐结构
26 
27```markdown
28# 项目名称
29 
30> 一句话价值主张，告诉用户“这东西解决什么问题”
31 
32[![Stars](badge)](link)
33[![License](badge)](link)
34[![Version](badge)](link)
35 
36## ✨ 项目亮点
37- 亮点 1：解决什么痛点
38- 亮点 2：与同类方案相比优势是什么
39- 亮点 3：适合谁使用
40 
41## 📦 安装
42```bash
43pip install xxx
44# 或 npm install / go install / cargo install
45```
46 
47## 🚀 快速开始
48```bash
49xxx init
50xxx run
51```
52 
53## 🧭 使用示例
54```python
55from xxx import yyy
56```
57 
58## 📁 项目结构
59- `src/`：核心实现
60- `tests/`：测试
61- `docs/`：扩展文档
62 
63## ❓ 适用场景
64- 场景 1
65- 场景 2
66- 场景 3
67 
68## 🛠️ 开发
69```bash
70make test
71make lint
72```
73 
74## 🤝 贡献
75欢迎 PR / Issue。
76 
77## 📝 License
78MIT
79```
80 
81## 工作流程
821. 检查项目结构、包管理文件、入口文件、测试目录和已有文档。
832. 提炼项目定位：目标用户、核心能力、和替代方案相比的差异点。
843. 优先补全“安装 / 快速开始 / 使用示例 / 项目结构 / 开发方式”。
85…