Readers use the table of contents or scan through the headings to find the required content. Therefore, headings must reflect the information that the readers search. The OpenStack documentation includes the following types of headings:
Use the following guidelines for all types of headings:
For details on RST formatting, see Titles.
Write the section title in gerund where possible.
Examples:
If a subsection contains a sub-subsection, start the title of the subsection with a verb in gerund or a noun.
Example:
Start the subsection or sub-subsection with a noun or an adjective if it is a concept or a reference topic.
Example:
Start the task topic title with an imperative verb.
Examples:
Follow these guidelines for figure and table titles:
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.