📝
WritingPython

中文 README 生成器

by laolaoshiren

中文 README 生成器 is a Writing skill for Claude Code, published by laolaoshiren in claude-code-skills-zh.

786 stars84 forkson laolaoshiren/claude-code-skills-zhAdded 2026/08/23+1% in starsRepository updated 2026/08/23
ai-agentawesome-listclaude-codeclaude-skillsdeveloper-toolsprompt-engineeringskills
Install in seconds
Install 中文 README 生成器
Copy 中文 README 生成器 into your Claude Code skills folder. Run the command in your terminal, or review the source on GitHub before installing.
terminal
npx degit https://github.com/laolaoshiren/claude-code-skills-zh/tree/main/skills/zh-readme ~/.claude/skills/zh-readme

Requires Node.js. Downloads this skill only — not the rest of the repository — into your Claude Code skills folder.

Without Node.js

git clone https://github.com/laolaoshiren/claude-code-skills-zh.git

Clones the whole repository, then copy the skill’s own directory into your skills folder yourself.

In this catalog

Source file
skills/zh-readme/SKILL.md in laolaoshiren/claude-code-skills-zh
Installs to
~/.claude/skills/zh-readme
Collection
One of 20 skills cataloged from this repository
Category
Writing1012 skills

What 中文 README 生成器 does

中文 README 生成器先分析项目代码和目录,再生成面向中文开发者的 README。适合写新项目介绍、重写 README、补全文档首页和优化开源仓库展示页。

中文 README 生成器 is cataloged under Writing on DirSkills. 中文 README 生成器 comes from a repository tagged ai-agent, awesome-list, claude-code, claude-skills and developer-tools.

Documentation

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 文案要与这些渠道保持口径一致,避免承诺和数据冲突。

This is the opening of the README. Read the full README on GitHub.

Frequently asked about 中文 README 生成器

  • What else does laolaoshiren publish alongside 中文 README 生成器?

    中文 README 生成器 is one of 20 skills that DirSkills catalogs from laolaoshiren/claude-code-skills-zh, the repository it ships in. Its siblings there include API Tester, Changelog Generator and Chinese Code Reviewer. Each one is a separate skill with its own page in this directory, installs the same way 中文 README 生成器 does, and is maintained by laolaoshiren in that same repository. The rest of the collection is listed on the laolaoshiren/claude-code-skills-zh page.

  • How does 中文 README 生成器 compare to other Writing skills?

    中文 README 生成器 ranks #568 by stars among the 1012 Writing skills in this catalog. The most-starred ones next to it are Article Writing, Social Media Content Calendar and Knowledge Comic Creator. DirSkills ranks by the star count of the repository each skill ships in, so that order reflects how popular those repositories are rather than any review of 中文 README 生成器 against them. Open each page to compare what they document and how they install.

More from laolaoshiren/claude-code-skills-zh

中文 README 生成器 is one of 20 skills cataloged on DirSkills from laolaoshiren/claude-code-skills-zh.

See all 20 skills