列表和表格
列表和表格在技术文档中很常见,因为它们让文字看起来清爽,更有条理。
列表
常见的列表有三种:
- 无序列表
- 有序列表
- 嵌入列表
无序列表
无序列表用于非步骤的内容的列举,顺序对于列表条目的排列并不重要。但是,无序列表的条目要保持平行,要使用同样的结构、逻辑、标点、和大小写。
比如,动物园里有很多动物:
- 狮子。(❌)狮子(✔)
- 錦雞(❌)锦鸡(✔)
- 大象
- 调皮的猴子 (❌)猴子(✔)
- 苍蝇(❌)羊驼(✔)
有序列表
有序列表用于描述步骤,要以动词开头。
比如,要把大象装冰箱,拢共分为三步:
- 打开冰箱门。
- 赶进大象。
- 关闭冰箱门。
嵌入列表
嵌入列表指句子中的列表。比如,我喜欢吃水果,最喜欢的水果是梨,香蕉,和苹果。
表格
解释软件界面,介绍软件各项设置,或呈现数据的时候,常用到表格。相比用长篇大论描述各个按钮的功能而言,表格可以让用户快速定位想要了解的按钮,也省去了作者不少的笔墨和心思。呈现数据的时候,表格也能更直观地展示出数据之间的差别。
以上是列表和表格在技术文档中的应用。它们让文档更清爽,从而减轻了用户的阅读负担。