Skip to content

laolaoshiren/claude-code-skills-zh / skills/zh-readme

zh-readme

Verified

中文 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、精选数量、更新时间或代表性案例。

推荐结构

# 项目名称

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

[![Stars](badge)](link)
[![License](badge)](link)
[![Version](badge)](link)

## ✨ 项目亮点
- 亮点 1:解决什么痛点
- 亮点 2:与同类方案相比优势是什么
- 亮点 3:适合谁使用

## 📦 安装
```bash
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


## 工作流程
1. 检查项目结构、包管理文件、入口文件、测试目录和已有文档。
2. 提炼项目定位:目标用户、核心能力、和替代方案相比的差异点。
3. 优先补全“安装 / 快速开始 / 使用示例 / 项目结构 / 开发方式”。
4. 如果缺少真实命令,基于仓库中的 `package.json`、`pyproject.toml`、`Makefile`、`Cargo.toml` 等提取。
5. 用中文重写标题、摘要和亮点,避免“强大、优雅、现代化”这类空词。
6. 最后检查 README 是否能支持首次访问者在 30 秒内理解并开始使用。

## 输出要求
- 默认使用 Markdown。
- 标题层级清晰,emoji 适量,不要堆砌。
- 示例命令必须可复制。
- 如果信息不足,显式标注“待补充”,不要编造不存在的特性。

## 自检清单
- 是否说明了项目解决的问题?
- 是否给出最短可运行示例?
- 是否覆盖安装、使用、贡献、License?
- 是否避免了 AI 腔和空泛营销语?
- 是否让中文开发者一眼看懂?
rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 198kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 198kUpdated Claude CodeCodexVerifiedInstall