zh-readme

Installation
SKILL.md

中文 README 生成器

触发条件

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

核心原则

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

首屏优化模板

  • 一句话价值主张:明确解决什么问题,避免“强大/优雅/现代化”之类空词。
Related skills
Installs
9
GitHub Stars
67
First Seen
Apr 23, 2026