编译:est-liu
编译自:Google Technical Writing One
有条件的读者应直接阅读原文,并完成给出的练习,增进理解。
选择正确的列表类型
技术写作有三种主流的列表类型:
- 子弹列表(小圆点,bulleted lists)
- 数字列表
- 嵌入式列表
子弹列表用于无序项目。(即便改变项目的顺序,意义也不会有改变,适用于“或”关系的项目。) 而数字列表则用于有序项目。
嵌入式列表,也称作插入式列表(run-in list),是指包含在句子内的项目。举例如下:
The llamacatcher API enables callers to create and query llamas, analyze alpacas, delete vicugnas, and track dromedaries.
一般来说,嵌入式列表并不是一种展示技术信息的好方法(违背了简洁明了的原则,且不便阅读),应尝试把嵌入式列表转换为子弹列表或数字列表。
列表项目保持一致
保持“一致”是测试列表有效性的试金石。那是什么“一致”呢?列表内项目应在以下方面保持一致:
- 语法
- 逻辑类别
- 大小写
- 标点符号
换句话来说,只要有一个项目在以上任意一个方面不一致,那这就是一个不一致的列表。而列表中排第一的项目的样式,就确立了读者接下来期望阅读的样式。
不一致的列表举例如下:
- carrots
- potatoes
- The summer light obscures all memories of winter.
这个列表在上述四个方面都不一致。语法上,前两个是名词,而最后一个是句子。逻辑上,前两个都是食材,而最后一个是文绉绉的句子,并不能吃。大小写上,前两个是全小写,最后一个是首字母大写。最后,标点也不符,前两个没有任何标点,而最后的句子有句点。
数字列表应用祈使动词开头
写数字列表时,考虑采用祈使动词开头,这样有利于保持列表项目的一致性。一个祈使动词(imperative verb)就是一个命令,比如说“下载”或“开始”。例如以下列表:
- Download the Frambus app from Google Play or iTunes.
- Configure the Frambus app's settings.
- Start the Frambus app.
为项目采用适当的标点符号
(针对英语文档) 如果列表项目是句子,则句首字母大写,并加上适当的标点。否则不要句首字母大写,也不要加标点。比如说,在以下句子构成的列表中,句首的“most”中的“m”需要大写,且句末需要加上句点。
- Most carambolas have five ridges.
而以下列表的项目并不是句子,所以我们并不把“the”中的“t”写成大写,句末也省略句点。
- the color of lemons
制作有用的表格
善于分析的人更喜欢阅读表格。要是给定一个包含多个段落和单个表格的页面,工程师的目光将聚焦到表格上。
在制作表格时,应考虑以下准则:
- 每一列都给出有意义的表头,不要让读者猜测每一列的内容。
- 避免往单个单元格里放太多文字。如果一个单元格内有超过两个句子,问问自己这些信息是否适用其他展示形式。
- 虽然不同列的数据类型可以不同,但是要尽量保证同一列内的数据类型一致。比方说,同一列单元格的数据不应该混杂数值型和字符串。
介绍列表和表格
我们建议用一个句子介绍每个列表和表格,告知读者列表和表格的含义。换言之,给出列表或表格的适用情景。介绍句的末尾使用冒号(:),不用句号。
虽然并非必须,我们还是建议在介绍句内加上“以下”字眼(putting the word following into the introductory sentence)。比如说以下的介绍句:
The following list identifies key performance parameters:
Take the following steps to install the Frambus package:
The following table summarizes our product's features against our key competitors' features: