Repo Docs Zh

Erstellt chinesische Repo-Dokumente aus echten Code-Ausführungen; englische Pfade und Symbole bleiben exakt

von YurunChen · YurunChen/repo-docs-skills

Getestet · Funktioniert ★ 8.8/10

Repo Docs Zh — Erstellt chinesische Repo-Dokumente aus echten Code-Ausführungen; englische Pfade und Symbole bleiben exakt

Was es kann

Chinesischsprachiges Overlay für den repo-docs Skill: Es erstellt ein repo-docs/-Paket, dessen Prosa Chinesisch ist, während Pfade, Befehle, Funktionen, Felder und andere Quell-Identifikatoren in ihrer Originalform zur Nachschlagezwecken bleiben. Es erzwingt eine verhaltensbasierte Struktur (README mit einer 阅读路径-Routing-Tabelle, einem nummerierten one-real-run Walkthrough, einer Evidenzbasis unter references/source-evidence.md) und liefert einen Python-Validator, der Struktur, Links und Evidenztabellen überprüft. Wird ausgelöst, wenn der Benutzer chinesische Repo-Dokumentation anfordert, repo-docs-zh erwähnt oder ein bestehendes repo-docs-Paket für chinesische Leser lokalisiert haben möchte.

Testbericht

In ein temporäres HOME installiert (beide Skills, da repo-docs-zh/SKILL.md ../repo-docs/* über relativen Pfad liest – das zh-Verzeichnis allein ist 1 Datei und unbrauchbar); Frontmatter mit name+description geparst, und ../repo-docs/SKILL.md, REFERENCE.md, EXAMPLES.md alle aufgelöst (HTTP 200 raw). Aufgabe: Chinesische Repo-Dokumentation für ein geklontes echtes Repo (simonw/files-to-prompt). BASELINE (kein Skill-Body) = eine 中文-Datei: Verzeichnisbaum, Funktionsliste, Optionstabelle, generischer 5-Schritte-Flow, null Ausführungen – ich habe das Tool nie ausgeführt. SKILL-Lauf erzwang zwei Evidenz-Durchläufe, sodass ich es tatsächlich ausführte und beide Artefakte konkret unterschiedlich sind: Das Skill-Paket dokumentiert eine reproduzierte Eigenart (eine .gitignore-Regel in demo2/sub1 schloss auch das Geschwister demo2/sub2/b.txt aus, die Ausgabe war nur c.txt) und eine Docstring-/Implementierungs-Diskrepanz (cli()-Hilfe sagt <document path=\"...">, die reale --cxml-Ausgabe ist <document index=\"1\"><source>...</source><document_content>, passend zu den filenames_from_cxml der Tests) – keiner der Strings erscheint irgendwo in der Baseline (grep-Zähler 0). Gebündelter Validator-Lauf: Skill-Paket "OK: 0 errors, 4 warnings" (--lite); die Baseline als Paket gab "FAILED: 7 error(s)" (fehlender Walkthrough/Evidenz/Change-Log, keine 阅读路径-Routing-Tabelle, Eröffnung hatte 26 Code-förmige Namen). Echte Reibung gefunden: Der chinesische Evidenztabellen-Header-Regex des Validators akzeptiert nur 结论/声明|证据|置信度|边界/备注|使用页面, und mein erster Versuch mit 断言|…|注意|被哪页使用 warnte – die zh SKILL.md dokumentiert diese genauen Spaltennamen nie. Auslöser-Formulierungen beurteilt (5/5 korrekt): SOLLTE – "给这个仓库生成一份中文的 repo-docs", "Generate repo documentation in Chinese for this codebase", "把现有的 repo-docs 包本地化给中文读者"; SOLLTE NICHT – "Translate this blog post into Chinese" (keine Repo-Dokumente), "Generate repo-docs for this repository" (unqualifiziert, das ist der englische repo-docs Skill, nicht das zh-Overlay). Sicherheitsprüfung sauber: keine curl|sh, base64-Blobs oder Exfiltration in den Skill-Dateien; der einzige Subprozess in validate_repo_docs.py ist ein lokales `git diff --name-only`.

Getestet am: 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"

Befehle & Beispiel-Prompts

  • /repo-docs-zhErstellt chinesische Repo-Dokumente aus echten Code-Ausführungen; englische Pfade und Symbole bleiben exakt

Skills reagieren auf normale Anfragen — keine Slash-Befehle nötig. Nach der Installation aktivieren Prompts wie diese den Skill (auf Englisch):

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