repo-docs
Build and maintain a Markdown guide that helps humans understand a repository through real behavior, concepts, and evidence. Use when a user asks to understand…
Generate and maintain repo-docs with Chinese as the primary reader language while preserving source identifiers for lookup. Use when the user asks for Chinese repo docs, mentions repo-docs-zh, wants repo documentation in Chinese, or wants an existing repo-docs package localized
$ npx -y skills add YurunChen/repo-docs-skills --skill repo-docs-zh --agent claude-codeHow it fires
How this skill gets triggered: by you, by Claude, or both.
/repo-docs-zhContext preview
The summary Claude sees to decide when to auto-load this skill.
Generate and maintain repo-docs with Chinese as the primary reader language while preserving source identifiers for lookup. Use when the user asks for Chinese repo docs, mentions repo-docs-zh, wants repo documentation in Chinese, or wants an existing repo-docs package localized
name: repo-docs-zh description: Generate and maintain repo-docs with Chinese as the primary reader language while preserving source identifiers for lookup. Use when the user asks for Chinese repo docs, mentions repo-docs-zh, wants repo documentation in Chinese, or wants an existing repo-docs package localized for Chinese readers.
This is the Chinese-language overlay for `repo-docs`. Structure, page ownership, evidence rules, sync behavior, and validation come from `../repo-docs/SKILL.md`. This overlay only changes language and Chinese reader experience.
Before acting, read:
1. `../repo-docs/SKILL.md` 2. `../repo-docs/REFERENCE.md` as the topic router only when detailed rules are needed 3. The routed topic file only when needed 4. `../repo-docs/EXAMPLES.md` only for output shape or tone examples needed by the task
Chinese repo-docs are not English docs translated line by line. They should rebuild the reader's conceptual handles in Chinese.
Chinese carries understanding: what this thing is, why it exists, what happens, what details matter, and how to check it. English identifiers locate the source: paths, commands, fields, API names, class/function names, metric names, package names, and dataset names.
`references/source-evidence.md` is still the fixed Build evidence base in Chinese packages. Write claims, caveats, and reader-facing notes in Chinese; keep paths, commands, fields, source identifiers, and exact evidence locators in their source form.
标准包中的 `code-map.md` 写成“代码地图”。它在主 walkthrough 之后回答:范围内每个源码目录负责什么,里面哪些文件或符号最重要,某类修改应该从哪里开始,相关验证在哪里。中文负责说清职责和改动入口,英文路径与符号负责精确定位。
If writing exposes a weak claim or insufficient evidence, pause drafting and return to the project evidence. Re-inspect the relevant source path, tests, config, schema, data, command output, or artifact; if the evidence is still missing, label the claim as `推断` / `未确认`, defer it explicitly, or leave it out.
Use a Chinese reader handle before a source locator.
| Type | Use in Chinese docs | | --- | --- | | 读者句柄 | The narrative subject, such as “导入流程”, “会话层”, “结果汇总”, “运行脚本”. | | 源码定位符 | Paths, functions, classes, fields, commands, artifact paths. Link directly with a Chinese label when one locator supports one claim. | | 机制细节名 | Metrics, schema keys, tool parameters, artifact file names. Put them in the owning module when they help the reader understand the concept. | | 外部术语 | Terms like benchmark, agent, workspace, protocol, memory. First mention gets a Chinese handle; later prefer Chinese when the term appears in the inspected repo. |
Default locator rule:
Good:
Bad:
Living project docs for coding agents: keep guides, progress logs, change maps, and handoff context updated as your repo evolves.
Repo: YurunChen/repo-docs-skills
Build and maintain a Markdown guide that helps humans understand a repository through real behavior, concepts, and evidence. Use when a user asks to understand…