2014年4月1日
言语简练,意思完整,这几乎是评判所有写作好坏的重要标准之一。
对技术文档工程师而言,言简意赅更是我们写作的努力方向。冗长的行文,拖沓的表达,不仅增加之后的翻译成本,更为重要的是,浪费了用户宝贵的时间和精力,从而让用户对文档甚至对产品留下不好的印象。
如何做到言简意赅?“The Elements of Style” 的作者 E.B. White 和 William Strunk Jr. 给一个很好的回答:
...
作者:Dan Wen | 分类:写作风格 | 评论 (0) | 阅读 ()
Google+
2014年3月29日
请按照技术写作的要求修改下面的句子:
- The default value of the <duration> parameter of this JS function is 100.
- Remove the selected record from the list by clicking Drop.
- You can create your maintenance plan with Schedule Editor.
- Enter the record number that you want to search for.
- Click on Next (or press on the Enter key).
...
作者:Dan Wen | 分类:写作风格 | 评论 (6) | 阅读 ()
Google+
2014年2月25日
请按照技术写作的要求修改下面的句子:
- The data integrity is checked by the scheduler.
- The following features can be found in this release.
- The error message can be removed by clicking Ignore.
- Verification of the digital signature is performed in the next step.
- Click Done.
The connection is now set up. - The maintenance report is generated monthly.
...
作者:Dan Wen | 分类:写作风格 | 评论 (6) | 阅读 ()
Google+
2013年11月1日
请按照技术写作的要求修改下面的句子:
- Enter your command in one line (i.e., without a line break).
- Measurements include weight, speed, distance, size, length, etc.
- e.g., you can set up a Tomcat server to host the web application.
...
作者:Dan Wen | 分类:写作风格 | 评论 (1) | 阅读 ()
Google+
2013年9月2日
一致性(Consistency)是技术写作里最重要的原则之一。即使是标点符号,也应保证其使用的一致性。
小小的横线,使用上也有区别。这里说的横线也就是 En Dash 和 Em Dash。
虽然这是技术写作里很基础的东西,还是在博客里记录一下,算是一个备忘吧。
...
作者:Dan Wen | 分类:写作风格 | 评论 (3) | 阅读 ()
Google+
2013年6月4日
以前一直以为It's和Its这么一个简单的语法问题,应该不会有人会弄错。可是在现实中,在需要使用its的地方却用了it's,这个错误在我帮工程师review文档的时候已经出现过不只一次,之前认为这应该只是个笔误吧。
...
作者:Dan Wen | 分类:写作风格 | 评论 (1) | 阅读 ()
Google+
2013年5月29日
这是Marcia Riefer-Johnston于2013年5月18日的一次Webinar,主题是"Language Matters: How To Write Powerful Sentences & Paragraphs"。
Marcia有着二十多年的technical writing经验,也在大学里教过tech writing的课程。
...
作者:Dan Wen | 分类:Webinar | 评论 (0) | 阅读 ()
Google+