New: 98,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Zh Readme

by laolaoshiren in laolaoshiren/claude-code-skills-zh

中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README. An agent skill from laolaoshiren/claude-code-skills-zh.

MITAuto-check passedDevelopment

Install Zh Readme

skills CLI
$ npx skills add laolaoshiren/claude-code-skills-zh --skill zh-readme -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install laolaoshiren/claude-code-skills-zh zh-readme --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/laolaoshiren/claude-code-skills-zh.git skills-src && mkdir -p .claude/skills && cp -r skills-src/skills/zh-readme .claude/skills/zh-readme && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
zh-readme
GitHub stars
880
Token cost
~477 tokens
SKILL.md length
76 words
Files
1
Skills in repo
19
Repo updated
First seen
Licence
MIT

At a glance

中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README. An agent skill from laolaoshiren/claude-code-skills-zh.

  • Works in 10 steps: 先读代码和目录，再写 README；不要只凭项目名猜功能。 → 面向中文开发者表达，技术名词保留英文，解释用自然中文。 → 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。 → …
  • Tasks that involve Technical documentation
  • SKILL.md covers 触发条件, 核心原则, 首屏优化模板 and 推荐结构, plus 7 more sections
  • Calls make

What it does

Zh Readme is an agent skill from laolaoshiren/claude-code-skills-zh. 中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README

Its SKILL.md is about 480 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation. The repository describes itself as: 面向中文开发者的 Claude Code Skills / Agents / Plugins 精选与原创技能库｜按场景分类｜复制即装｜持续更新. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation

Example prompts

  • “/zh-readme”

Requirements

  • Python 3
  • Node.js

Workflow steps

10 steps, taken from the first numbered list in SKILL.md.

  1. 先读代码和目录，再写 README；不要只凭项目名猜功能。
  2. 面向中文开发者表达，技术名词保留英文，解释用自然中文。
  3. 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。
  4. 优先给出真实命令、真实路径、真实示例，少写空泛宣传语。
  5. 如果项目已有 README，先保留有效信息，再补全缺失结构。
  6. 如果项目包含官网或文档站，README 中必须给出统一、可点击的正式入口链接，避免 README / 官网 / Issue 模板地址不一致。
  7. 项目介绍页要尽量补上社交证明信号（如 Star、精选数量、更新时间、代表性场景），帮助访客快速判断是否值得继续浏览。
  8. README 首屏必须具备“30 秒价值判断”能力：首句价值主张 + 适合谁用 + 最短安装方式，缺一不可。
  9. 如果项目带官网、Issue 模板、下载镜像或社区入口，优先整理为单一正式入口，减少用户在多个链接间来回跳转。
  10. 如存在 badge、Hero 文案、官网首页等配套渠道，README 文案要与这些渠道保持口径一致，避免承诺和数据冲突。

What it can do on your machine

Read from SKILL.md and the folder at commit 633f21c. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • make

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Zh Readme loads about 477 tokens when it runs. Until then it costs about 13 tokens; SKILL.md has 76 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~13
When it runs · the whole SKILL.md, loaded when a task matches
~477

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from laolaoshiren/claude-code-skills-zh at commit 633f21c, republished under its MIT licence (© laolaoshiren). 76 words, ~477 tokens.

Download SKILL.mdSave it as .claude/skills/zh-readme/SKILL.md (or your agent's skills folder).
name
zh-readme
description
中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README

中文 README 生成器

触发条件

当用户要求写 README、重写项目介绍、补全文档首页、优化开源仓库展示页时激活此技能。

核心原则

  1. 先读代码和目录，再写 README；不要只凭项目名猜功能。
  2. 面向中文开发者表达，技术名词保留英文，解释用自然中文。
  3. 首页要解决三个问题：这是什么、为什么值得用、怎么快速上手。
  4. 优先给出真实命令、真实路径、真实示例，少写空泛宣传语。
  5. 如果项目已有 README，先保留有效信息，再补全缺失结构。
  6. 如果项目包含官网或文档站，README 中必须给出统一、可点击的正式入口链接，避免 README / 官网 / Issue 模板地址不一致。
  7. 项目介绍页要尽量补上社交证明信号（如 Star、精选数量、更新时间、代表性场景），帮助访客快速判断是否值得继续浏览。
  8. README 首屏必须具备“30 秒价值判断”能力：首句价值主张 + 适合谁用 + 最短安装方式，缺一不可。
  9. 如果项目带官网、Issue 模板、下载镜像或社区入口，优先整理为单一正式入口，减少用户在多个链接间来回跳转。
  10. 如存在 badge、Hero 文案、官网首页等配套渠道，README 文案要与这些渠道保持口径一致，避免承诺和数据冲突。

首屏优化模板

  • 一句话价值主张：明确解决什么问题，避免“强大/优雅/现代化”之类空词。
  • 适合谁用：点名目标用户或典型场景，例如“面向中文开发者”“适合团队协作”“适合零配置上手”。
  • 最短安装方式：给出一段可直接复制的命令，优先放 GitHub 原生地址；如有镜像，再作为补充。
  • 统一入口：官网、文档、Issue 征集、下载方式尽量收敛到 1 个正式入口，减少用户决策成本。
  • 社交证明：在不堆砌数据的前提下，展示 star、精选数量、更新时间或代表性案例。

推荐结构

markdown
# 项目名称

> 一句话价值主张，告诉用户“这东西解决什么问题”

[![Stars](badge)](link)
[![License](badge)](link)
[![Version](badge)](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 腔和空泛营销语？
- 是否让中文开发者一眼看懂？

© laolaoshiren, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in skills/zh-readme of laolaoshiren/claude-code-skills-zh.

Open the folder on GitHubat commit 633f21c

Compare with similar skills

Zh Readme next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Zh Readme compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Zh Readme this skilllaolaoshiren/claude-code-skills-zh880—~477Automated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design49k1 repos~7.6kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0
Draw.io Diagram StudioAgents365-ai/drawio-skill10k—~2.4kAutomated safety check: NotesMIT

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    49k GitHub starsUsed in 1 repo~7.6k tokens
    DevelopmentAuto-check passed

  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed

  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed

  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated today
    DevelopmentAuto-check: notes

  • Dark Architecture Diagram Builder

    Cocoon-AI/architecture-diagram-generator

    Creates dark-themed system, cloud, security and network architecture diagrams as self-contained HTML files with inline SVG and CSS.

    7.4k GitHub starsUsed in 1 repo~2.1k tokens
    DevelopmentAuto-check passed

More from laolaoshiren/claude-code-skills-zh

All 19 skills in this repo

  • API Tester

    laolaoshiren/claude-code-skills-zh

    依据真实 OpenAPI、路由实现和现有测试生成并验证 API 测试。用于用户要求测试接口、补集成测试、验证 API 契约、生成回归用例或排查接口兼容性时；区分“生成测试”和“执行请求”的授权，不猜测状态码、响应结构或 SLA，不在未确认环境中发送写请求。

    880 GitHub stars~614 tokensUpdated 6 days ago
    Auto-check passed

  • Dep Auditor

    laolaoshiren/claude-code-skills-zh

    审计 Node.js、Python、Go、Rust、JVM、Ruby 项目的依赖漏洞、版本健康度与许可证事实；当用户要求检查 package.json、lockfile、requirements、go.mod、Cargo.toml、pom.xml、Gemfile.lock，或生成不改依赖的中文审计报告时使用

    880 GitHub stars~895 tokensUpdated 6 days ago
    Auto-check passed

  • Eslint Fix

    laolaoshiren/claude-code-skills-zh

    安全诊断并修复 ESLint error、warning 和配置兼容问题。用于用户要求运行 lint、解释 ESLint 报错、限定范围自动修复或迁移 ESLint 配置时；优先使用项目锁定的包管理器与版本，先预检再修改，不自动下载最新版或批量改写无关源码。

    880 GitHub stars~436 tokensUpdated 6 days ago
    Auto-check passed

  • Git Workflow

    laolaoshiren/claude-code-skills-zh

    安全处理 Git 状态检查、提交信息、commit、分支、push、PR 和 rebase。用于用户要求检查改动、生成或创建提交、管理分支、推送、发起 PR 或整理历史时；严格区分每个动作的授权，并保护工作树中已有和无关的修改。

    880 GitHub stars~513 tokensUpdated 6 days ago
    Auto-check passed

  • GitHub Actions Gen

    laolaoshiren/claude-code-skills-zh

    分析真实项目并生成或修订安全、可验证的 GitHub Actions workflow；当用户要求创建 CI、测试矩阵、构建、Release、部署、缓存、Secrets、OIDC、PR 自动化或排查 workflow 配置时使用

    880 GitHub stars~1.1k tokensUpdated 6 days ago
    Auto-check: notes

  • Skill Curator

    laolaoshiren/claude-code-skills-zh

    中文 Skill 收录评估器。用于核验 GitHub 上的 Claude Code、Codex、Agent Skills、Plugin、MCP、CLI 或 Agent 工作流是否值得加入精选列表；检查真实资产、安装方式、活跃度、重复项和安全边界，并生成分类、中文描述与可追溯证据。

    880 GitHub stars~756 tokensUpdated 6 days ago
    Auto-check passed

Categories

Questions about Zh Readme

What does Zh Readme do?

中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README. An agent skill from laolaoshiren/claude-code-skills-zh. Zh Readme is an agent skill from laolaoshiren/claude-code-skills-zh.

When should I use Zh Readme?

Zh Readme fits situations like: tasks that involve Technical documentation.

How do I install Zh Readme in Claude Code?

Run `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-readme -a claude-code`. Or copy the skill folder (skills/zh-readme in laolaoshiren/claude-code-skills-zh) into .claude/skills/zh-readme in your project. Claude Code loads it when a task matches its description.

How do I install Zh Readme in Codex?

Run `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-readme -a codex`. Or copy the skill folder (skills/zh-readme in laolaoshiren/claude-code-skills-zh) into .agents/skills/zh-readme in your project. Codex loads it when a task matches its description.

Can I use Zh Readme in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add laolaoshiren/claude-code-skills-zh --skill zh-readme -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/zh-readme, .gemini/skills/zh-readme, .github/skills/zh-readme and .opencode/skills/zh-readme in your project.

What does Zh Readme need to run?

Going by SKILL.md and its folder, Zh Readme needs the command-line tools its instructions call (make). Our summary lists: Python 3; Node.js.

Does Zh Readme access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Zh Readme safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Zh Readme use?

Zh Readme is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Zh Readme use?

About 477 tokens (SKILL.md is roughly 1.9k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Zh Readme?

Skills that share tags, products or a category with Zh Readme: Diagram Design (cathrynlavery/diagram-design, 49k stars), Simple English (moeru-ai/airi, 50k stars), Doc Sync (JetBrains/ideavim, 10k stars) and Mailspring App Screenshots (Foundry376/Mailspring, 18k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Zh Readme?

laolaoshiren (a GitHub user) maintains it in laolaoshiren/claude-code-skills-zh, which has 880 GitHub stars. The repository holds 19 skills in this directory. The repository was last updated on October 5, 2026.

Source: laolaoshiren/claude-code-skills-zh on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.