English | 中文
本文规定如何在本仓库文档配对的两侧之间进行翻译。两种语言同权(见 README.md):一次变更用任一语言撰写,那一侧就是这次更新的源——本文的规则约束的是产出或更新另一侧。这些规则对人和 agent(智能体)同等生效;应用它们的进仓 agent 工作流是 .agents/skills/dsh-translate-docs。规则级别沿用 RFC 2119 的用法:必须(MUST)/禁止(MUST NOT)会卡门禁或评审;应当(SHOULD)偏离时要说明理由;可以(MAY)自行裁量。
配对的两个文件必须在以下方面一一对应:
ts 块要通过 doc-typecheck 编译),而被改动的注释是代码块计数门禁看不见的漂移,.md 路径而非 .zh.md 兄弟文件——这样某对文档先于相邻文件落地时,链接也永不悬空。唯一的 zh 特有链接是语言切换行。链接文字翻译;链接目标不翻。本仓库的 Markdown 约定对 .zh.md 文件原样生效:一个段落一个物理行(verify-md-wrap)、相对链接必须可解析(verify-md-links)、文件末尾恰好一个换行。
agent(智能体),之后写 agent)与「不要译作」的禁项。中文先行撰写时,英文另一侧同样按表中英文列使用术语。本节规则约束中文一侧;英文一侧遵循仓库常规的 Markdown 约定(根 AGENTS.md)。下面的中西文混排规则遵循 MDN 简体中文翻译指南、Kubernetes 中文本地化指南、Vue.js 中文翻译须知与中文文案排版指北的跨项目共识,其根据是 W3C clreq 与 GB/T 15834—2011:
每个 plugin 注册 3 个 tool。全角标点与任何字符之间不加空格。,。:;?!()「」。半角标点保留在代码内、按原样引用的完整英文句子内、以及数字内(3.5、1,024)。123,永远写 123。github/Github。**加粗**、*斜体*)落在与另一侧相同的文字段上;中文没有斜体,渲染效果可能看不出差别——不要用引号或其他装饰替代。pnpm run verify-translation-pairing 和 doc-sync 的其余门禁检查——跑门禁;门禁覆盖的不要手工核对。本文各规则引用的权威出处,供想了解底层依据的人和 agent 查阅: