17、技术信息呈现与组织的实用指南

技术信息呈现与组织的实用指南

在技术信息的撰写和组织过程中，遵循一定的风格和组织原则至关重要，这不仅能提升信息的可读性和可理解性，还能让用户更轻松地找到他们所需的内容。以下将详细介绍列表呈现、语言使用、信息组织等方面的关键要点。

列表项的一致呈现

不同的风格指南对列表项的要求有所不同，但许多技术风格指南推荐以下规则：
1. 引导句使用完整句子 ：除非风格指南明确要求使用片段，否则列表的引导句应使用完整句子。
2. 列表项至少两项 ：一个列表中应至少包含两个项目。
3. 列表项保持平行 ：确保各个列表项在结构和语法上保持一致。
4. 首字母大写 ：每个列表项的开头字母应大写。
5. 标点使用一致 ：如果一个列表项以句号结尾（因为它是一个句子），则所有列表项都应使用句号；如果所有列表项都不是句子，则不用句号。

例如，下面的列表就违反了上述部分规则：
- Menu names and choices
- bold
- To create a new project, click Project —» New.
- Message text
- monospace
- Action complete message …
- New terms (where defined)
- italics
- A hierarchy is a …
- Paramet