Repo Docs Zh

Crea documentazione repo cinese da esecuzioni di codice reali; percorsi e simboli inglesi rimangono esatti

di YurunChen · YurunChen/repo-docs-skills

Promosso ★ 8.8/10

Repo Docs Zh — Crea documentazione repo cinese da esecuzioni di codice reali; percorsi e simboli inglesi rimangono esatti

Cosa fa

Overlay in lingua cinese per la skill repo-docs: costruisce un pacchetto repo-docs/ la cui prosa è in cinese mentre percorsi, comandi, funzioni, campi e altri identificatori sorgente rimangono nella loro forma originale per la consultazione. Impone una struttura 'behavior-first' (README con una tabella di routing 阅读路径, un walkthrough numerato one-real-run, una base di evidenze sotto references/source-evidence.md) e fornisce un validatore Python che controlla struttura, link e tabelle di evidenze. Si attiva quando l'utente chiede documentazione repo cinese, menziona repo-docs-zh, o desidera un pacchetto repo-docs esistente localizzato per lettori cinesi.

Rapporto di test

Installato in una HOME temporanea (entrambe le skill, poiché repo-docs-zh/SKILL.md legge ../repo-docs/* tramite percorso relativo — la sola directory zh è 1 file e inutilizzabile); frontmatter analizzato con name+description, e ../repo-docs/SKILL.md, REFERENCE.md, EXAMPLES.md tutti risolti (HTTP 200 raw). Task: documentazione repo cinese per un repository reale clonato (simonw/files-to-prompt). BASELINE (nessun corpo skill) = un file 中文: albero dir, lista funzioni, tabella opzioni, flusso generico a 5 passi, zero esecuzioni — non ho mai eseguito lo strumento. L'esecuzione della SKILL ha forzato due passaggi di evidenza, quindi l'ho effettivamente eseguita ed entrambi gli artefatti differiscono concretamente: il pacchetto skill documenta una stranezza riprodotta (una regola .gitignore in demo2/sub1 escludeva anche il file demo2/sub2/b.txt, l'output era solo c.txt) e una discrepanza docstring/implementazione (l'aiuto cli() dice <document path="...">, l'output reale --cxml è <document index="1"><source>...</source><document_content>, corrispondente ai filenames_from_cxml dei test) — nessuna delle due stringhe appare nella baseline (grep count 0). Esecuzione del validatore incluso: pacchetto skill "OK: 0 errors, 4 warnings" (--lite); la baseline inserita come pacchetto ha dato "FAILED: 7 error(s)" (walkthrough/evidence/change-log mancanti, nessuna tabella di routing 阅读路径, l'apertura aveva 26 nomi a forma di codice). Attrito reale trovato: la regex dell'intestazione della tabella di evidenze cinese del validatore accetta solo 结论/声明|证据|置信度|边界/备注|使用页面, e il mio primo tentativo con 断言|…|注意|被哪页使用 ha avvertito — il zh SKILL.md non documenta mai quei nomi esatti di colonna. Frasi trigger giudicate (5/5 corrette): DOVREBBE — "给这个仓库生成一份中文的 repo-docs", "Generate repo documentation in Chinese for this codebase", "把现有的 repo-docs 包本地化给中文读者"; NON DOVREBBE — "Translate this blog post into Chinese" (non documentazione repo), "Generate repo-docs for this repository" (non qualificata, è la skill repo-docs inglese, non l'overlay zh). Scansione di sicurezza pulita: nessun curl|sh, blob base64 o esfiltrazione nei file della skill; l'unico sottoprocesso in validate_repo_docs.py è un `git diff --name-only` locale.

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

Installazione

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"

Comandi e prompt di esempio

  • /repo-docs-zhCrea documentazione repo cinese da esecuzioni di codice reali; percorsi e simboli inglesi rimangono esatti

Gli skill si attivano con richieste in linguaggio naturale, senza comandi da ricordare. Dopo l'installazione, prompt come questi lo attivano (in inglese):

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