Rules for Translation

文档结构

每一篇文章分为五个部分：中英对照表、正文、引用、注解、总结；

  • 中英对照表：文章中出现过的专用名词在中英对照表中说明，使用list方式呈现。
  • 正文：正文位于第二部分，参考下边正文部分内容。
  • 引用：如果系统中存在外部链接，使用引用格式处理，引用使用脚标（参考本文最下边）：[1]。
  • 注解：注解中添加一些作者辅助理解的文字说明，正文保持干净整洁，注解可直接参考注解部分，使用圆括号：(1)。
  • 总结：总结部分为本文的最终说明，Summary结束语。

文档状态

  • 每一份文档在最开始的Title中加入状态后缀，只有Release的版本可省略不加。
  • 状态主要如下：
    • Draft：草稿，翻译者完成文档翻译过后提交第一个版本为草稿，等待校对。
    • Review：正在校对的版本，一旦文档开始校对则将文档改动成Review状态，校对可交叉进行。
    • Internal：最终校对一致通过的版本，内部完善版本。
    • Release：最终发布版，没有明显错误，可大规模提供给读者阅读的版本。

正文规则

  1. 中英文共存：如果有些内容不容易翻译，并且使用频率不高，没有出现在中英对照表中，则在正文部分使用（E）格式提供英文原文，这种使用主要用于小频率单词且带有协变意义的单词部分，且标注时仅标注第一次出现的地方。
    共享数据（Shared Data）——当然这个只是个例子，这里可以直接使用SharedData（Vert.X中的专用类）来表示。

  2. 专用名词：有些常用的专用名词不需要翻译，如：Java API，Vert.X Core等。

  3. 补齐文字：有些文本中英文的指代部分若已经完结，而中文部分不容易处理时直接使用括号补齐，正文本身内容保证“直译”为主，还原文档的原始状态。

  4. 标点符号：一句完整的话结尾尽可能不使用分号，而是用句号代替，并且注意将英文中有些逗号改成中文顿号。

  5. 分类说明：有些通篇英文是按照一点一点叙述，这种情况如果有需要使用list方式呈现，每一个知识点使用一个list进行说明。

  6. 原文注释：Vert.X的官方文档中有NOTE部分，这部分内容用引用Quote处理，格式统一为 请注意：之后文字斜体处理，如在文字中包含有Note字样，则翻译成注意：之后文字用斜体处理便可。

  7. 代码注释：代码中的注释部分需要翻译，有相当一部分注释包含了重要的指引讯息，故需要翻译。

引用

  1. Enter footnote here