Repo Docs Zh

Bygger kinesiska repo-dokument från verkliga kodkörningar; engelska sökvägar och symboler förblir exakta

av YurunChen · YurunChen/repo-docs-skills

Testad · Fungerar ★ 8.8/10

Repo Docs Zh — Bygger kinesiska repo-dokument från verkliga kodkörningar; engelska sökvägar och symboler förblir exakta

Vad den gör

Kinesisk-språkigt överlägg för repo-docs-färdigheten: den bygger ett repo-docs/-paket vars prosa är kinesisk medan sökvägar, kommandon, funktioner, fält och andra källidentifierare förblir i sin ursprungliga form för uppslagning. Den tvingar fram en beteende-först-struktur (README med en 阅读路径 rutt-tabell, en numrerad one-real-run walkthrough, en bevisbas under references/source-evidence.md) och levererar en Python-validator som kontrollerar struktur, länkar och bevis tabeller. Utlöses när användaren ber om kinesisk repo-dokumentation, nämner repo-docs-zh, eller vill ha ett befintligt repo-docs-paket lokaliserat för kinesiska läsare.

Testrapport

Installerad i en tillfällig HOME (båda färdigheterna, eftersom repo-docs-zh/SKILL.md läser ../repo-docs/* via relativ sökväg — zh-katalogen ensam är 1 fil och oanvändbar); frontmatter tolkades med name+description, och ../repo-docs/SKILL.md, REFERENCE.md, EXAMPLES.md löstes alla (HTTP 200 raw). Uppgift: Kinesisk repo-dokumentation för ett klonat verkligt repo (simonw/files-to-prompt). BASELINE (ingen färdighetskropp) = en 中文-fil: katalogträd, funktionslista, alternativtabell, generiskt 5-stegsflöde, noll exekveringar — jag körde aldrig verktyget. SKILL-körning tvingade fram två bevispass, så jag exekverade det faktiskt och båda artefakterna skiljer sig konkret: färdighetspaketet dokumenterar en reproducerad egenhet (en .gitignore-regel i demo2/sub1 exkluderade även syskonet demo2/sub2/b.txt, utdata var endast c.txt) och en docstring/implementeringsavvikelse (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). Säkerhetsskanning ren: inga curl|sh, base64-blobbar, eller exfiltrering i färdighetsfilerna; den enda subprocessen i validate_repo_docs.py är en lokal `git diff --name-only`.

Testad: 2026-07-31 · Claude Code 2.x (agent harness)

Installation

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"

Kommandon och exempelprompter

  • /repo-docs-zhBygger kinesiska repo-dokument från verkliga kodkörningar; engelska sökvägar och symboler förblir exakta

Skills triggas av vanliga förfrågningar — inga kommandon att memorera. Efter installationen aktiverar prompter som dessa skillen (på engelska):

  • Generate Chinese docs for this repository
  • Write a Chinese README for this project
  • Document this codebase in Simplified Chinese