Zh Readme Skill for Claude
中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README
Install
one command, takes just this skill from the repositorynpx skills add https://github.com/laolaoshiren/claude-code-skills-zh --skill zh-readmeThe instruction itself
2 sections, as written by the author中文 README 生成器
触发条件
当用户要求写 README、重写项目介绍、补全文档首页、优化开源仓库展示页时激活此技能。
核心原则
- 先读代码和目录，再写 README；不要只凭项目名猜功能。
- 面向中文开发者表达，技术名词保留英文，解释用自然中文。
- 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。
- 优先给出真实命令、真实路径、真实示例，少写空泛宣传语。
- 如果项目已有 README，先保留有效信息，再补全缺失结构。
- 如果项目包含官网或文档站，README 中必须给出统一、可点击的正式入口链接，避免 README / 官网 / Issue 模板地址不一致。
- 项目介绍页要尽量补上社交证明信号（如 Star、精选数量、更新时间、代表性场景），帮助访客快速判断是否值得继续浏览。
- README 首屏必须具备“30 秒价值判断”能力：首句价值主张 + 适合谁用 + 最短安装方式，缺一不可。
- 如果项目带官网、Issue 模板、下载镜像或社区入口，优先整理为单一正式入口，减少用户在多个链接间来回跳转。
10. 如存在 badge、Hero 文案、官网首页等配套渠道，README 文案要与这些渠道保持口径一致，避免承诺和数据冲突。
首屏优化模板
- 一句话价值主张：明确解决什么问题，避免“强大/优雅/现代化”之类空词。
- 适合谁用：点名目标用户或典型场景，例如“面向中文开发者”“适合团队协作”“适合零配置上手”。
- 最短安装方式：给出一段可直接复制的命令，优先放 GitHub 原生地址；如有镜像，再作为补充。
- 统一入口：官网、文档、Issue 征集、下载方式尽量收敛到 1 个正式入口，减少用户决策成本。
- 社交证明：在不堆砌数据的前提下，展示 star、精选数量、更新时间或代表性案例。
推荐结构
# 项目名称
> 一句话价值主张，告诉用户“这东西解决什么问题”
[](link)
[](link)
[](link)
## ✨ 项目亮点
- 亮点 1：解决什么痛点
- 亮点 2：与同类方案相比优势是什么
- 亮点 3：适合谁使用
## 📦 安装
pip install xxx
或 npm install / go install / cargo install
## 🚀 快速开始
xxx init
xxx run
## 🧭 使用示例
from xxx import yyy
## 📁 项目结构
- `src/`：核心实现
- `tests/`：测试
- `docs/`：扩展文档
## ❓ 适用场景
- 场景 1
- 场景 2
- 场景 3
## 🛠️ 开发
make test
make lint
## 🤝 贡献
欢迎 PR / Issue。
## 📝 License
MIT
工作流程
- 检查项目结构、包管理文件、入口文件、测试目录和已有文档。
- 提炼项目定位：目标用户、核心能力、和替代方案相比的差异点。
- 优先补全“安装 / 快速开始 / 使用示例 / 项目结构 / 开发方式”。
- 如果缺少真实命令，基于仓库中的
package.json、pyproject.toml、Makefile、Cargo.toml等提取。 - 用中文重写标题、摘要和亮点，避免“强大、优雅、现代化”这类空词。
- 最后检查 README 是否能支持首次访问者在 30 秒内理解并开始使用。
输出要求
- 默认使用 Markdown。
- 标题层级清晰，emoji 适量，不要堆砌。
- 示例命令必须可复制。
- 如果信息不足，显式标注“待补充”，不要编造不存在的特性。
自检清单
- 是否说明了项目解决的问题？
- 是否给出最短可运行示例？
- 是否覆盖安装、使用、贡献、License？
- 是否避免了 AI 腔和空泛营销语？
- 是否让中文开发者一眼看懂？
Other skills for the same job
different authors, same section of the catalogue
Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).
Automatically creates user-facing changelogs from git commits by analyzing commit history, categorizing changes, and transforming technical commits into clear, customer-friendly release notes. Turns hours of manual changelog writing into minutes of automated generation.
Use when implementation is complete, all tests pass, and you need to decide how to integrate the work - guides completion of development work by presenting structured options for merge, PR, or cleanup
Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).
React Native and Expo best practices for building performant mobile apps. Use when building React Native components, optimizing list performance, implementing animations, or working with native modules. Triggers on tasks involving React Native, Expo, mobile performance, or native platform APIs.
React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.
Next.js best practices - file conventions, RSC boundaries, data patterns, async APIs, metadata, error handling, route handlers, image/font optimization, bundling
Use when starting feature work that needs isolation from current workspace or before executing implementation plans - creates isolated git worktrees with smart directory selection and safety verification
How to use it
Take laolaoshiren/zh-readme from the repository into ~/.claude/skills for personal
use, or into .claude/skills inside a project.
The agent identifies a skill by the name field in its header. Two skills with the
same name cannot sit side by side — one of them will be ignored.
The instructions reference pip, npm, cargo, go.
Without those the skill loads but fails at the first command.