您好,欢迎来到花图问答。
搜索
您的当前位置:首页英语技术文档中如何正确使用时态?

英语技术文档中如何正确使用时态?

来源:花图问答

Foreword

关于英语技术文档的时态问题,相信上过英语技术文档写作课程或者自己阅读过相关专业书籍的 Technical Writer 应该已经了解。如果不了解的话,那是时候补一补课了哦~

理想状态下,如果文档输出者全都是专业的 Technical Writer,就比较容易控制时态规范。但是,对于 GitHub 上开源项目的文档来说,文档输出者有时是做开发的程序员小伙伴们,毕竟术业有专攻,就难免会出现时态使用不规范的情况。

英语技术文档中的时态使用不当可能有两个方面的原因:一是不清楚时态使用规范;二是虽然知道规范,但是在需要主观判断时判断不当。是的,有时是需要主观判断的,并根据主观判断来选择使用何种时态。

接下来,跟大家分享一下英语技术文档中的时态规范具体是怎样的。内容结构如下:

  • 英语技术文档的时态规范
  • IBM 的时态规范
  • Google 的时态规范

1. 英语技术文档的时态规范

这里所说的英语技术文档中的时态,指的是文档中所用动词的时态。其实,用一句话即可诠释英语技术文档的时态规范,具体如下:

尽量使用一般现在时 (present tense);只有当使用一般现在时会引起误解或不合逻辑时,才考虑一般将来时或过去时等其它时态。

绝对大多数情况下,我们接触的技术文档均须使用一般现在时,除非特殊情况,而这种特殊情况是很少的。

你可能会问了:为什么非要用一般现在时呢?这是因为与其它时态相比,一般现在时的更加客观、规范,易于翻译。

你还可能会问了:我怎么辨别那些可能会引起误解或不合逻辑的特殊情况呢?别着急,下文有例子,这一点需要在具体的实践中积累经验。

2. IBM 的时态规范

IBM Style Guide 的第一章 Language and Grammar 中对技术文档的时态规范进行了明确描述,具体如下:

  • Write in the simple present tense as much as possible.

    • 错误示例: When you open the latch, the panel will slide forward.
    • 正确示例: When you open the latch, the panel slides forward.
  • Use past or future tense only when you cannot use present tense or it does not make sense to use present tense.

    • 错误示例: If you selected New in the previous window, the current window will display the recommended default values. Cancel a broker deployment only if you are sure that the broker never responds to the deployment request.
    • 正确示例: If you selected New in the previous window, the current window displays the recommended default values. Cancel a broker deployment only if you are sure that the broker will never respond to the deployment request.

书中截图如下:

另外,IBM 出的另一本书 Developing Quality Technical Information 中,也对技术文档时态的使用进行了详细说明,说重点的三句话如下:

  • You should use the present tense for your verbs whenever possible.
  • Use the past or future tense only when the present tense would be misleading or illogical.
  • Unless you have a good reason to use the past or future tense, always write in the present tense.

举例如下:

  • 错误示例:The Web pages were uploaded during the installation.
  • 正确示例:The Web pages are uploaded during the installation.

书中截图如下:

3. Google 的时态规范

Google Developer Documentation Style Guide 中对时态也有清晰的说明,重要的几句话如下:

  • In general, use present tense rather than future tense; try to avoid using "will" where possible.
  • The fact that the reader will be writing and running code in the future isn't a good reason to use future tense. Stick with present tense where possible.
  • Key Point: Avoid "will."
  • Also avoid the hypothetical future "would."
  • 错误示例1:Send a query to the service. The server will send an acknowledgment.

  • 正确示例1:Send a query to the service. The server sends an acknowledgment.

  • 错误示例2:You can send an unsubscribe message. The server would then remove you from the mailing list.

  • 正确示例2:If you send an unsubscribe message, the server removes you from the mailing list.

网页截图如下:

Afterword

笔者发现,随着时代的发展,有些传统的技术写作规范在今天不必再严格遵守,但有一些还是需要严格遵守的,最终的目的是一致,都是为了让技术文档更易用,让用户使用起来体验更好。

如果你在实践中遇到过关于英语技术文档时态的烦恼或者有意思的事情,或者有自己独到的看法,欢迎留言交流哦~

小伙伴的留言或消息我都会一一看的,只是有时候错过了可回复的时间,想回复也无法发送了……

你可能想读

-END-

Copyright © 2019- huatuowenda.com 版权所有 湘ICP备2023022495号-1

违法及侵权请联系:TEL:199 1889 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务