标题¶
读者使用目录或扫描标题来查找所需的内容。因此,标题必须反映读者搜索的信息。OpenStack 文档包含以下类型的标题:
章节标题
主题标题
图表标题
通用指南¶
对于所有类型的标题,请使用以下指南:
使用句子风格的 capitalization(首字母大写)。
使标题简短但具有描述性。
在标题中使用冠词,但不要以冠词开头。
避免使用不常见的缩写。
不要在标题结尾使用句号或冒号。
不要使用双反引号 (``) 来突出显示内容。
在两个紧挨着的标题之间添加一些介绍性文本。
有关 RST 格式的详细信息,请参阅 标题。
章节标题¶
尽可能使用动名词形式编写章节标题。
示例
监控性能
管理资源
子章节标题¶
如果子章节包含子子章节,则以动名词形式的动词或名词开头子章节标题。
示例
测试 OpenStack 环境
测试 Ceph 和 OpenStack 的互操作性
测试 Ceph 和 Glance
测试 Ceph 和 Cinder
测试 Ceph 和 Rados GW
测试 Ceph 和 Swift
如果主题是概念或参考主题,则以名词或形容词开头子章节或子子章节。
示例
维护您的环境
一般注意事项
主题标题¶
以祈使动词开头任务主题标题。
示例
添加节点
删除节点
图表标题¶
遵循以下图表标题指南:
在介绍表格、图或图表时,添加一个简短的描述性标题。
不要在标题中添加“表格”、“图”或“图表”字样。
不要对表格、图或图表进行编号。
将标题放置在表格、图或图表的上方。
使标题字体加粗。
屏幕截图不需要标题。