Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 3.5 KB

DOCUMENTATION-LANGUAGES.zh-CN.md

File metadata and controls

35 lines (20 loc) · 3.5 KB

文档语言规范

English · 简体中文

状态:家族已采用的文档规范,2026-10-23。面向中文用户与全球英文社区;不改变软件行为、协议标识、源码许可或产品价格。

公开入口

公开默认文档使用英文,如 README.md、PRICING.md、docs/getting-started.md;提供完整的简体中文对应文件 README.zh-CN.md、PRICING.zh-CN.md、docs/getting-started.zh-CN.md,标题附近双向链接。中文是正式用户路径,不是简短附录;英文也不能只是中文收费方案的摘要。

库优先保证 README、安装/首个有效示例、支持平台限制、排错和 API/参考文档入口。全球贡献者应能在不读中文或私人聊天的情况下理解并使用库。已有英文 API 与协议参考仍是技术定义权威;中文指南明确链接该规范。

产品的入门、使用/恢复/更新、免费和付费范围、试用/到期、续购/取消、配额、隐私及密钥/数据去向应在两种语言中同等可发现。翻译完整承诺,包括限制和开卖状态,不只翻译功能标题。产品站保持中英内容对等,文档链接跟随语言。

一套技术含义

英文 API/协议/安全语义为技术规范权威,示例、schema fixtures、测试向量只维护一套。译文解释同一契约,不改变输入、失败行为或成熟度。保留 API 名、CLI 参数、路径、schema 标识和可复制命令;不建两套语言实现或执行队列。

中英公开产品政策必须在价格/币种、数量、平台、时间窗、试用/到期、取消、续购、保留时限、免费范围和实现状态上相同。任何一版都不能凭空变出在售商品、无限额度、硬件资格或已支持手机。行为仍由已审查的 offer/policy 和仓库规格决定,不能靠改文案静默改行为。用户承诺改变时在同一 PR/commit 更新两种语言,或明确不发布该承诺直到配对文本就绪。

译文与技术参考冲突时,修正后才能声称路径就绪。不能以“英文技术规范优先”为理由忽略中文购买承诺冲突;两版一致前阻止该 offer 开卖。实际结账条款另行明确效力顺序并遵循适用消费者保护,本工程规范不代替这些条款。

范围与维护

历史 issue、commit message、事故记录和内部草稿不必全部复制成两套。新增可复用维护指南、贡献说明及 issue/PR 摘要应能被英文读者理解;本地工作笔记可用任一语言。路线图、ADR、changelog 允许单份英文,不为统计文件数而维护第二份权威协议规范。

优先补齐公开用户旅程,不翻译整个历史档案。已知仍有中文为主的内部 agent 材料、历史审查和 issue;不能据此宣称所有仓库文档都已双语。缺失或过期的译文要明确标注;可链接现有版本,但不能静默切换语言或谎称对等。

审查清单

  1. 打开英文、中文入口,检查互链及目标文件语言。
  2. 对照命令/示例与全部数量、承诺事实:价格、配额、保留、平台、时限、状态;保留待做/失败/未跑边界。
  3. 检查网站两种语言的方案、帮助、反馈、隐私,已有译文时链接相应语言文件。
  4. 运行相关文档、链接、构建检查。仅翻译不新增运行测试,除非改变命令、生成示例或可执行文档;现有 required CI 仍适用。
  5. 记录已翻译文件及剩余缺口;不能仅凭 README 成对就报告所有文档/平台完成。