Repo-Docs ZH (Chinese repo documentation overlay)
A Chinese-language overlay for the repo-docs skill that rebuilds documentation concepts in Chinese while keeping paths, commands and API names in their original form.
What it does
This is the Chinese overlay for the repo-docs skill. Structure, page ownership, evidence rules, sync behavior and validation all come from the base skill; this file only governs language and Chinese reader experience.
- Rebuilds conceptual handles in Chinese instead of translating English docs line by line.
- Keeps source identifiers exact: paths, commands, config keys, API/class/function names, metric names, package and dataset names.
- Fixes page shapes: README
## 阅读路径reader-goal table, glossary columns术语 | 项目里的意思 | 延伸阅读, numbered## Step Nwalkthroughs, and acode-map.md(代码地图) page with路径 | 职责 | 关键代码 | 与主流程的关系. - Requires weak claims to be labeled
推断/未确认, deferred, or dropped rather than guessed. - Includes a de-AI pass: strip filler phrases, avoid overusing dashes and bold sub-headings, avoid "not only… but also…" as the main explanation.
- Keeps
AGENTS.mdin English, adding only one routing sentence telling future agents to apply this overlay.
Who it's for
- Teams shipping repo documentation for Chinese-speaking readers.
- Maintainers already using
repo-docsin English who want a parallel Chinese package. - Technical writers who want readable docs instead of translationese.
Examples
- "Generate Chinese repo-docs for this project" → README with a reading-path table, main walkthrough, code map, modules, and
references/source-evidence.md. - Localize an existing English
repo-docs/package: Chinese link labels pointing at the real source paths, never long raw paths as visible prose text. - When a claim lacks evidence, the skill forces a return to the source (tests, config, schema, command output) or an explicit
未确认label.
· · · Install guide · · ·
Try it now, no install
Paste this into Claude to use the skill without installing anything.
Read the instructions in this file and follow them to help me: https://raw.githubusercontent.com/YurunChen/repo-docs-skills/HEAD/skills/repo-docs-zh/SKILL.md What I want: (describe your task here)
If Claude can't open the link, open it yourself and paste the contents instead.
↓ If it works for you, download the ZIP below and install it. Then it runs on its own — no pasting each time.
Install in the Claude app (no terminal)
- Download the ZIP with the button below.
- In Claude, open Settings → Capabilities and turn on 'Code execution and file creation'. (one time)
- Go to Customize → Skills → + → 'Upload a skill' and upload the ZIP.
Install in Claude Code
Let Claude do it — paste this into Claude Code
Install the skill I found on Claude Skill Mart. Copy the skills/repo-docs-zh folder from the GitHub repo YurunChen/repo-docs-skills into my ~/.claude/skills/yurunchen-repo-docs-zh/. When it's done, tell me in one line what this skill can do.
Install with a command instead
git clone https://github.com/YurunChen/repo-docs-skills.git && cp -r repo-docs-skills/skills/* ~/.claude/skills/⚠ This is a third-party skill. Check the source repository before installing.
- Open a terminal.
- Clone the repository:
git clone https://github.com/YurunChen/repo-docs-skills.git - Create the skills folder:
mkdir -p ~/.claude/skills - Copy all skills, including the base one (this overlay reads
../repo-docs/SKILL.md, so it won't work alone):cp -r repo-docs-skills/skills/* ~/.claude/skills/ - Verify both
~/.claude/skills/repo-docs-zh/and~/.claude/skills/repo-docs/exist. - Restart Claude Code, open the repo you want documented, and ask: "use repo-docs-zh to build Chinese repo docs".