文本构建实用指南
1. 文本元素概述
在构建文本时,文本和图形元素的使用至关重要,如章节标题、表格和交叉引用等。呈现这些元素有多种可接受的方式,选择合适的设计、布局和写作风格能让文档独具特色。同时,应遵循一些在已发布的计算机文档中行之有效的风格和写作惯例,确保文档格式易于读者识别和理解,并在整个文档中保持一致。
2. 标题的使用
2.1 标题的作用与层级
标题用于描述后续内容,其合适的位置取决于文档内容和信息流向。一级标题用于最宽泛的总结,随着层级推进到四级标题,内容应更加具体,且不建议超过四级标题。若有更多主题需涵盖,应重构文本,并且尽量保证每个层级至少有两个标题。
2.2 撰写章节标题的准则
- 避免模糊标题:如“概述”这类标题过于模糊,应明确总结章节的具体信息。例如,“介绍”应改为“Sun Fire V880 功能”,“前面板”应改为“前面板功能”。
- 从读者角度出发:标题应反映读者的视角,而不是作者自己的视角。比如,“认证”应改为“管理系统认证选项”。
- 保持标题简洁且有意义:简洁的标题便于在文本和目录中浏览。像“ChorusOS 4.0 支持的功能”可改为“ChorusOS 4.0 功能”。
- 重要词汇前置:将最重要的词汇放在标题开头,例如“Netra 高可用性要素”应改为“Netra 高可用性功能”。
- 使用平行结构