Heading levels and nesting

Last Updated : Oct 11, 2024 |

When creating topics, pay attention to where you place them in your document. Avoid nesting topics under each other and creating unnecessary heading levels. A simple chapter should only have two heading levels. Avoid redundant hierarchy levels. For more complex content, you can add up to three heading levels.

Only add a third heading level if it helps to show how topics relate to each other. If the content would be clear without a third heading level, do not include the extra level. Do not add a third heading level for only one topic. Avoid using more than three heading levels. If you have too many heading levels, the document becomes harder for people to navigate.

You should also avoid adding a separate overview topic right after a chapter title. Instead, start the chapter with a concept topic and put your overview information in the top-level topic for the chapter.

The following example shows the preferred method of structuring topics:

Preferred

Discouraged

  • H1: Firmware management

    • H2: Activating a firmware package

    • H2: Updating the path to a firmware package

    • H2: Deactivating a firmware package

  • H1: Firmware management

    • H2: Firmware management overview

    • H2: Activating a firmware package

      • H3: Updating the path to a firmware package

    • H2: Deactivating a firmware package

The Discouraged column in the above example has a redundant overview topic and an unnecessary heading level.