Menu

Individual skill

zh-readme

0upvotes

中文 README 生成器 - 先分析项目，再生成面向中文开发者的高质量 README

skills/zh-readme/SKILL.md

Read pinned source

Source commit 4521b155d36e50fd7a103a46e3a24d48241508af

What was checked

Matches the observed repository HEAD
Yes
Scanner rules are current
Yes
Repository scan complete
No
Skill scan complete
No
Observed behavior
Instructions only
Last checked
Nov 10, 2026

These are observations at the recorded commit, not a guarantee of safety. Review the source before running it.

Install this skill

Choose an agent in your Stack or copy a command below. Commands fetch the pinned commit and copy only this skill directory. Existing destinations are refused. Copying a command does not install anything.

An install command is unavailable: current rules, complete repository and skill scans, an eligible behavior level and a permitted license are required.

Repository context

Repository stars (not skill ratings)
906
Repository last updated
Nov 11, 2026
License
MIT

Observed agent integration: No specific integration evidence. Standard SKILL.md installation does not imply verified compatibility.

Files and excerpt

File metadata and permitted, redacted excerpts come from the recorded scan. Source links are pinned to that commit.

Browse files
Read excerpt

# 中文 README 生成器

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

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