主题结构

OpenStack 社区欢迎所有文档贡献者。本节提供了一些关于如何使用基于主题的写作原则来构建 OpenStack 项目内容的思路。

基于主题的写作是一种内容创作方法，其中信息被结构化为特定类型的小块。与具有线性结构的书籍内容相反，在基于主题的写作中，你假定用户可以从任何主题开始阅读文档。因此，每个主题代表一个独立的信息片段。每个主题都会说明前提条件和依赖关系（如果有的话），以及提供有关后续步骤的信息。

在基于主题的写作中，信息块被称为 主题。

围绕以下主题构建信息

概念

概念主题解释特定的功能。它不提供步骤序列或关于如何使用该功能的信息。

概念主题标题示例：OpenStack 组件和服务的介绍。

概念主题包括

• 标题

• 描述

• 相关链接

• (可选) 图表

• (可选) 示例

任务

任务主题提供一系列步骤（过程），详细说明如何实现特定结果，例如配置网络。如果您有与任务相关的概念性信息，请在过程之前放入概述中。使过程中的步骤简洁明了。用动词开始过程中的每个步骤。如果步骤包含命令示例，请以冒号 (:) 结尾介绍句。

概念主题标题示例

• 章节主题标题：监控性能。

• 任务主题标题：删除节点，从故障中恢复。

任务主题包括

• 标题

• 简短描述（概述）

• 过程（一系列步骤）

• 结果

• 相关链接（另请参阅）

• (可选) 示例

参考

参考主题提供有关功能的更多信息。通常，参考主题中的信息以列表或表格的形式呈现。

参考主题标题示例：支持的操作系统。