翻译工作，其实还有有一些最佳实践的。

文档翻译不只是单纯的单词翻译，不能说做到信达雅，目标是努力做到这边，而且技术文档本身不会使用太多典故、暗语，都是相对平白的简单句。翻译的过程很快乐，能比一般人更理解作者表达的含义，因为每句话你都经历过翻译、思考、评审。

github flow 整体流程

  • 认领
  • 翻译
  • 校对
  • 合并完成

最佳实践，经验总结：

  • 认领文档，避免重复翻译。这里需要维护一个文档大纲、或者 github project 用来表述当前状态
  • fork - clone，应当考虑 depth 忽略以往的提交减少时间 - 创建分支
  • 了解中文排版说明和相关词汇表，如果没有应该沉淀一个
  • 有些作者的表述很随意，这部分内容大胆修改，改成陈述句
  • 提交附件默认会要求遵守 angular 的 commit ，也就是 docs(xxxx): xxx
  • 翻译的评论，译注需要用到角标。 <sup>[[1]](xxx)</sup> 混用了 html + markdown ，内容是链接。
  1. <small>
  2. __译者注__
  3. <a id="footnote-1"></a>[1] ...
  4. <a id="footnote-2"></a>[2] ...
  5. <a id="footnote-3"></a>[3] ...
  6. </small>
  • 中英文行数保持一致，不吞行，多行。但有的不是很在意。
  • 中间空格，别纠结，汉字、数字、英文 之间要有空格。但英文在开头和结尾显然不需要
  • 使用中文符号，中文逗号
  • 有的专有词不用翻译，比如 webpack vue macOS 不用翻译，注意大小写
  • 有专有名词尤其是缩写建议加括号注释 模块热更换(H… M… R…) 这里的括号使用英文，视觉协调。但有的人不这么认为，他们认为全用中文标点。
  • 代码只翻译注释，有的组织不建议翻译注释，看个人
  • 链接、斜体等语法前后空格，视觉好看

Github 的 PR，可以提 review 和 comment ，可以配合使用。

下面参考 vitepress 的介绍：
image.png

-1 参考文档