技术文档翻译实例解析：始于翻译，经于沟通，终于易用

摄于 2019 年秋 @ 北京 by Lilian

Foreword

如果一个产品或项目的文档需要同时维护不同的语言版本，例如中文版和英文版，那么 Technical Writer 的工作就会涉及技术文档的翻译。

之前分享过深度解析关于技术翻译的六个认知误区和技术翻译需要有 Technical Writer 的 sense，也分享过一些实例解析。

这一篇将以一个英译中的句子为例，跟大家分享一下在技术文档翻译的过程中，源文本不易用是怎样一种体验，以及如何处理。如果你的工作中也涉及类似场景，或许会有同感；如果你是尚未入行的在校生，可以提前了解下实践中的技术文档翻译，或许跟你想象中的差别很大。

本文结构如下：

1. 始于翻译
2. 经于沟通
3. 终于易用

1. 始于翻译

一般来讲，如果源文本或源材料的语言表述比较清晰，翻译起来就比较顺畅。

偶尔遇到表述不够明确易用的地方，Technical Writer 根据自己已有的技术基础、对产品的认识、对程序员表述习惯的了解，以及上下文背景，或者再结合 Google 搜索业界类似场景的表达，也可以编译为规范清晰的版本。

然而，也有些时候，Technical Writer 自己实在无法确定原文的意思。例如，我在根据英语源文本准备 TiDB 数据库的某个中文文档时，曾遇到这样一句话：

The actual number of nodes created are multiplied by the number of availability zones in the region.

如果直译的话，可能为：「实际创建的节点数乘以该 Region 中的可用区数。」

这样翻的话，感觉话没说完……

或者：「实际创建的节点数被该 Region 中的可用区数相乘。」

这样翻的话，也怪怪的……

总之，很难 get 到这句话的完整意思。

2. 经于沟通

在翻译技术文档的过程中，如果自己实在无法理解源文本的意思，或者不能确定自己理解的是正确的，就一定要与原作者或者相关团队的技术同学进行沟通，切忌按自以为的意思提交。

于是，我找了相关团队的技术同学进行请教。大致的沟通过程如下：

(E = Engineer, T = Technical Writer)

• T：Hi E，请教个问题：xx 文档里的这句话是啥意思？The actual number of nodes created are multiplied by the number of availability zones in the region.（附上了这句话以及出处链接）

• E：配置文件里的 node 的个数，其实是每个可用区的个数，比如配了 2，但是 Region 一共有 3 个可用区，那最终结果是 6 个节点，每个可用区会起 2 个节点。

  variable "pd_count" {
  description = "Number of PD nodes per availability zone"
  default     = 1
  }
  
  variable "tikv_count" {
  description = "Number of TiKV nodes per availability zone"
  default     = 1
  }
  
  variable "tidb_count" {
  description = "Number of TiDB nodes per availability zone"
  default     = 1
  }
  
  variable "monitor_count" {
  description = "Number of monitor nodes per availability zone"
  default     = 1
  }
  

• T：（看到这些解释，清楚了很多，跟 T 同学确认我的理解）哦~是这个意思吗？The actual total number of nodes is equal to the number of nodes in the configuration file multiplied by the number of Availability Zones in the Region. 实际创建的总节点数等于配置文件中的节点数乘以该 Region 中可用区的个数。

• E：我看看上下文啊~嗯，是这个意思，但是是按组件来的。

• T：那可以用我上面发的那个版本吗？

• E：我觉得应该加上按组件，上面的版本会让用户以为是所有节点，其实是 PD 的节点，TiKV 的节点……

• T：好的~“在 TiDB、PD、TiKV 组件中实际创建的总节点数等于配置文件中的节点数乘以该 Region 中可用区的个数。”这样？

• E：还有监控。

• T：在某一组件中实际创建的总节点数等于配置文件中的节点数乘以该 Region 中可用区的个数。

• E：为任一组件实际创建……是不是这样好点儿？

• T：可以的~“为任一组件实际创建的总节点数等于配置文件中的节点数乘以该 Region 中可用区的个数。”这样？

• E：嗯。

• T：谢谢！

• E：没事。

至此，沟通愉快地结束了。程序员同学有自己的表达方式，很多时候需要 Technical Writer 去问去沟通，才能明白原来 TA 是想说这个意思。

Technical Writer 就像一个挖掘内容的人，有些想要的信息是需要问出来的。这一点在实际工作中深有感触。提问本身也是一门学问。

上面举的只是一个一句话的例子，还有很多时候需要 Review 程序员同学写的整篇文档。如果整体组织有问题、缺少必要的内容，那就需要与作者沟通，抛给 TA 几个必要的问题。如果能回答得好，那内容就完整了。

3. 终于易用

上面确定了中文版的表述，再来看下英文版：

• 英语源文本：The actual number of nodes created are multiplied by the number of availability zones in the region.

• 英语改进版：The total number of nodes actually created for each component is equal to the number of nodes in the configuration file multiplied by the number of Availability Zones in the Region.

这样看来，源文本缺少必要的信息，且表述不明确，让人看了一头雾水，很不易用。改进版里的意思就清楚多了。

Afterword

技术文档翻译可能没有你想得那么简单，实践中会遇到各种复杂的情况。

Technical Writer 除了要准确翻译出源文本的基本意思外，还要善于挖掘源文本真正想表达的意思，以确保最终呈现给用户的文档是易用的。这样才能为产品和用户之间搭起一座走得通的桥梁。

如果你也是处理不同语言文档的 Technical Writer，经常遇到类似场景，欢迎留言交流心得体会；如果你是尚未入行的同学，有什么疑惑也欢迎留言提问，我知道的都会解答。

-END-

猜你想读：

什么样的人适合做 Technical Writer？
技术文档诞生记 | 完整的技术写作流程是怎样的？
Technical Writer 可提供的交付物有哪些？
Write the Docs：连接技术文档人的全球社区，附海量学习资源
GitHub + Markdown 的新轻型技术写作模式速览
GitHub + Markdown 的技术文档方案深度解析
Technical Writer 日常工作中好用的小工具
技术传播人士应该知道的色彩搭配常识
如何使用颜色来提高技术文档的可读性？
Technical Writer 如何 Review 技术文档？| 重细节+全局观
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感？
书单 | 有哪些技术传播从业者必知必看的书籍？
有哪些适合技术传播从业者关注的优质博客？（一）
有哪些适合技术传播从业者关注的优质博客？（二）
行业动态 | 国内有哪些高校开设了技术传播或技术写作课程？
IEEE ProComm 2019 国际传播大会上，中国代表团有哪些精彩分享？
优质免费资源推荐 | 9 期技术写作短视频教程带你从入门到进阶
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议（上篇）
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议（下篇）
Technical Writer 想参与开源项目为文档做贡献，需提前掌握哪些知识？
Technical Writer 如何参与开源项目的文档，以不断提升专业技能?
技术传播沙龙精彩分享 | 高校老师与行业大牛谈“互联网技术写作”
经验分享 | 对用户文档进行伤筋动骨式的重构是怎样一种体验？
英语技术文档的标题到底该大写还是小写？
不同阶段如何应对 Technical Writer 的职业顾虑或烦恼？
如何使用正则表达式批量添加和删除字符？
英语技术文档中如何正确使用时态？
英语技术文档中如何正确使用人称？
英语技术文档中如何正确使用无序列表和有序列表？
Markdown：写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录？
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解，直译得再正确又有何意？
优质译文不应止于正确，还要 Well-Organized
Technical Writer 需要 Technical 到会写代码吗？
如何利用 GitHub Pages 和 Hugo 轻松搭建个人博客？
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记