美文网首页技术文档写作
英文技术写作:中国人常犯的语法错误(Common Mistake

英文技术写作:中国人常犯的语法错误(Common Mistake

作者: Joy的未来十年 | 来源:发表于2017-12-06 12:00 被阅读71次

这一节主要以示例形式给出中国人在英文写作时易犯的语法错误。
摘自我在2016年12月给MA开发工程师所做技术写作讲座(Writing Tips for Technical Guides)。

Ambiguous Pronoun References

When two or more nouns precede a pronoun, the one to which the pronoun refers is ambiguous. Pronouns usually identify themselves with the nearest nouns.

Example: You can add a table to the database and modify it.
Corrected: You can add a table to the database and modify the table.

Misunderstanding Caused by Dangling Participles

Dangling participles are present or past participles that are hanging there in your sentence with no proper subjects in sight.
Dangling participles can cause serious misunderstanding. A participle goes with the noun or pronoun closest to it, either directly preceding or following it.

Example: Designed to help implement specialized reporting, you can use this feature to automate your data downloads.
Corrected: Designed to help you implement specialized reporting, this feature enables automated data downloads.

Misused Lists

Use a bulleted list for items that do not need to be in order.
Use a numbered list for items that need to be in order.

Example: IIS 6.0 supports two modes of operation:
1. IIS 5.0 isolation mode
2. IIS 6.0 native mode
Corrected:
IIS 6.0 supports two modes of operation:
*IIS 5.0 isolation mode
*IIS 6.0 native mode

Missing Noun Determiners

Use noun determiners to help identify the nouns that follow. Noun determiners include:

  • Articles: a, an, the
  • Possessive nouns, such as Elena’s. Possessive pronoun/adjectives: my, your, his, …
  • Demonstrative pronoun/adjectives: this, that, these, those
  • Quantifiers: all, any, each, either, every, few, many, more, most, much, some, several, and so on.
  • Numbers: one, two, and so on.

Example: The Preview pane provides user a quick view on workflow-level information .
Corrected: The Preview pane provides users a quick view on the important workflow-level information.

Unclear Words

Unclear words are often ambiguous and subject to misinterpretation.

Example: Since you registered on Support Web, you can begin downloading the setup file.
Corrected: Because you registered on Support Web, you can begin downloading the setup file.

Example: Once you register as a new user on Support Web, you can begin downloading the setup file.
Corrected: After you register as a new user on Support Web, you can begin downloading the setup file.

Miscellaneous

Indicate the names for UI components that you will reference later.

Example: In a New Page window, click Edit.
英文技术写作系列

相关文章

网友评论

  • aae1ad37029d:可以研究下用户为什么不喜欢使用技术文档的:blush:
    aae1ad37029d:@Joy的未来十年除了因为现有文档是line based,以及不够简洁,您觉得还有什么原因导致用户不使用手册呢
    Joy的未来十年:@像雾又像雨 用户通过是在万不得已,实在无法解决问题时(very frustrated状态时),才会想到看手册。所以,技术手册--一定要task-based,便于快速搜索到“主题”,二则文字一定要简洁。

本文标题:英文技术写作:中国人常犯的语法错误(Common Mistake

本文链接:https://www.haomeiwen.com/subject/zvukixtx.html