Skip to content
Grey Li edited this page Jun 13, 2022 · 5 revisions

认领流程

  • 创建认领 PR 在章节后添加你的用户名(PR 标题可使用 Claim docs/request
  • 认领 PR 被合并后开始翻译
  • 开始翻译并提交翻译 PR(PR 标题可使用 Translate docs/request
  • 翻译 PR 被合并后再认领新的章节

翻译要求

  • 所有的命令、代码块、链接(链接文本需要翻译)、类/函数/方法/变量名等都不作翻译和改动。
  • 可以使用翻译工具,但务必进行二次优化和调整。
  • 尽可能直译,某些不适合直译的地方可以进行意译。可以对译文作必要的调整,比如增加少量有助于理解的说明词汇,或是省略一些在中文不方便表达的套话(没有实际含义)。
  • 某些不适合翻译的单词可以保留英文原文,不确定的地方请在 PR 中备注出来,大家一起讨论。
  • 类似 !!! warning!!! tip 这样的格式标记不需要翻译。
  • 版本提示的标题不需要翻译,类似 "Version >= 0.5.0"
  • 不用每一个「you」都翻译出来,可以适当调整。
  • 使用「你」而不是「您」。

排版要求

  • 中英文之间保留空格
  • 中文和数字之间保留空格
  • 超链接文本与正文之间保留空格
  • 每行长度尽量与英文原文保持一致,且每一行都尽量保持同等长度
  • 中文符号与英文单词之间不需要再添加空格,例如:✅ 我参加了 PyCon。❌ 我参加了 PyCon 。
  • 中文符号后面不需要额外添加空格。例如:✅ 你也参加了?太好了!❌ 你也参加了? 太好了!

建议阅读:

  1. 中文文案排版指北
  2. 译文排版规则指北

推荐的翻译工具

翻译词汇讨论

https://github.com/apiflask/docs-zh/discussions/10

聊天群组

翻译词汇对照:

WIP