Repo Docs Zh
Builds Chinese repo docs from real code runs; English paths and symbols stay exact
Test report
- Verdict
- Tested · Works
- Score
- Tested
- Jul 31, 2026
- Environment
- Claude Code 2.x (agent harness)
- Upstream re-checked
- Aug 10, 2026 · cd30899
Installed into a throwaway HOME (both skills, since repo-docs-zh/SKILL.md reads ../repo-docs/* by relative path — the zh dir alone is 1 file and unusable); frontmatter parsed with name+description, and ../repo-docs/SKILL.md, REFERENCE.md, EXAMPLES.md all resolved (HTTP 200 raw). Task: Chinese repo docs for a cloned real repo (simonw/files-to-prompt). BASELINE (no skill body) = one 中文 file: dir tree, function list, option table, generic 5-step flow, zero executions — I never ran the tool. SKILL run forced two evidence passes, so I actually executed it and both artifacts differ concretely: the skill package documents a reproduced quirk (a .gitignore rule in demo2/sub1 also excluded the sibling demo2/sub2/b.txt, output was only c.txt) and a docstring/implementation mismatch (cli() help says <document path="...">, real --cxml output is <document index="1"><source>...</source><document_content>, matching tests' filenames_from_cxml) — neither string appears anywhere in the baseline (grep count 0). Bundled validator run: skill package "OK: 0 errors, 4 warnings" (--lite); the baseline dropped in as a package gave "FAILED: 7 error(s)" (missing walkthrough/evidence/change-log, no 阅读路径 route table, opening had 26 code-shaped names). Real friction found: the validator's Chinese evidence-table header regex only accepts 结论/声明|证据|置信度|边界/备注|使用页面, and my first attempt with 断言|…|注意|被哪页使用 warned — the zh SKILL.md never documents those exact column names. Trigger phrasings judged (5/5 correct): SHOULD — "给这个仓库生成一份中文的 repo-docs", "Generate repo documentation in Chinese for this codebase", "把现有的 repo-docs 包本地化给中文读者"; SHOULD NOT — "Translate this blog post into Chinese" (not repo docs), "Generate repo-docs for this repository" (unqualified, that's the English repo-docs skill, not the zh overlay). Security scan clean: no curl|sh, base64 blobs, or exfiltration in the skill files; the only subprocess in validate_repo_docs.py is a local `git diff --name-only`.
Scored on four weighted criteria — install, triggering, output vs. baseline, docs. How scoring works
- Installs cleanly 5/5
- Triggers reliably 5/5
- Output vs. baseline 8/10
- Docs & honesty 4/5
What Repo Docs Zh does
Chinese-language overlay for the repo-docs skill: it builds a repo-docs/ package whose prose is Chinese while paths, commands, functions, fields and other source identifiers stay in their original form for lookup. It enforces a behavior-first structure (README with a 阅读路径 route table, a numbered one-real-run walkthrough, an evidence base under references/source-evidence.md) and ships a Python validator that checks structure, links and evidence tables. Triggers when the user asks for Chinese repo documentation, mentions repo-docs-zh, or wants an existing repo-docs package localized for Chinese readers.
How to install Repo Docs Zh
git clone --depth 1 https://github.com/YurunChen/repo-docs-skills.git /tmp/repo-docs-zh-src
mkdir -p ~/.claude/skills
cp -R /tmp/repo-docs-zh-src/skills/repo-docs ~/.claude/skills/repo-docs
cp -R /tmp/repo-docs-zh-src/skills/repo-docs-zh ~/.claude/skills/repo-docs-zh
# Both dirs are required: repo-docs-zh/SKILL.md is an overlay that reads ../repo-docs/SKILL.md,
# REFERENCE.md, PAGE_RULES.md and EXAMPLES.md by relative path. Installing only repo-docs-zh leaves it broken.
# Upstream alternative: bash /tmp/repo-docs-zh-src/install.sh --agent claude (installs both skills, same layout)
# Validator (bundled, Python 3 stdlib only, no extra deps):
# python3 ~/.claude/skills/repo-docs/scripts/validate_repo_docs.py <repo>/repo-docs --repo-root <repo> [--lite]
# Usage: "用 repo-docs-zh 给这个仓库生成中文文档" / "Generate Chinese repo docs for this project"
Skills live in ~/.claude/skills/ (global) or .claude/skills/
(per-project). Restart Claude Code after installing.
Commands — how to trigger Repo Docs Zh
-
/repo-docs-zhBuilds Chinese repo docs from real code runs; English paths and symbols stay exact
It also activates on plain-language prompts like these:
-
Generate Chinese docs for this repository -
Write a Chinese README for this project -
Document this codebase in Simplified Chinese
Frequently asked questions
- Is the Repo Docs Zh skill free?
- Yes. The skill itself is free from YurunChen/repo-docs-skills. SkillProof publishes the install command and an independent test verdict at no cost.
- Does Repo Docs Zh work with Claude Code?
- We tested it with Claude Code 2.x (agent harness) on Jul 31, 2026. Verdict: Tested · Works. Installed into a throwaway HOME (both skills, since repo-docs-zh/SKILL.md reads ../repo-docs/* by relative path — the zh dir alone is 1 file and unusable); frontmatter parsed with name+description, and ../repo-docs/SKILL.md, REFERENCE.md, EXAMPLES.md all resolved (HTTP 200 raw). Task: Chinese repo docs for a cloned real repo (simonw/files-to-prompt). BASELINE (no skill body) = one 中文 file: dir tree, function list, option table, generic 5-step flow, zero executions — I never ran the tool. SKILL run forced two evidence passes, so I actually executed it and both artifacts differ concretely: the skill package documents a reproduced quirk (a .gitignore rule in demo2/sub1 also excluded the sibling demo2/sub2/b.txt, output was only c.txt) and a docstring/implementation mismatch (cli() help says <document path="...">, real --cxml output is <document index="1"><source>...</source><document_content>, matching tests' filenames_from_cxml) — neither string appears anywhere in the baseline (grep count 0). Bundled validator run: skill package "OK: 0 errors, 4 warnings" (--lite); the baseline dropped in as a package gave "FAILED: 7 error(s)" (missing walkthrough/evidence/change-log, no 阅读路径 route table, opening had 26 code-shaped names). Real friction found: the validator's Chinese evidence-table header regex only accepts 结论/声明|证据|置信度|边界/备注|使用页面, and my first attempt with 断言|…|注意|被哪页使用 warned — the zh SKILL.md never documents those exact column names. Trigger phrasings judged (5/5 correct): SHOULD — "给这个仓库生成一份中文的 repo-docs", "Generate repo documentation in Chinese for this codebase", "把现有的 repo-docs 包本地化给中文读者"; SHOULD NOT — "Translate this blog post into Chinese" (not repo docs), "Generate repo-docs for this repository" (unqualified, that's the English repo-docs skill, not the zh overlay). Security scan clean: no curl|sh, base64 blobs, or exfiltration in the skill files; the only subprocess in validate_repo_docs.py is a local `git diff --name-only`.
- What is the Repo Docs Zh SkillProof Score?
- 8.8/10 — installs cleanly 5/5, triggers reliably 5/5, output vs. baseline 8/10, docs & honesty 4/5.
- How do I install Repo Docs Zh?
- Copy the install command from this page, run it in your terminal, and restart Claude Code. Skills live in ~/.claude/skills/ (global) or .claude/skills/ inside a project.
- Can I use Repo Docs Zh with Cursor, Copilot, Gemini CLI, Codex or other AI tools?
- The SKILL.md format is native to Claude (Claude Code, Desktop, claude.ai). The instructions inside adapt to other assistants: Cursor rules, GitHub Copilot instructions, Windsurf rules, Custom GPTs, AGENTS.md for OpenAI Codex, and GEMINI.md for Google Gemini CLI — our conversion guides cover each, and the free converter on the tools page does the wrapping for you.