Structuring Documentation

%product% documentation index contains five elements:

All elements can be re-ordered by dragging and dropping them.

To re-order an element far away in the index, you can either:

  • Click on its menu, choose Re-arrange, then a category to send the element to its bottom.
  • Drag the element to the absolute top or absolute bottom of the index, the index will start scrolling automatically.

Index Depth

Index can be three level deep at most. Categories as top-level elements can hold parent pages, and parent pages can hold sub-pages. A sub-page cannot have subpages of its own.

A deeper documentation index makes it harder for the reader to find the information they need. A flatter hierarchy provides an easier navigation experience. Remember that complex lengthy subjects can be extracted into separate documentation. Also, making categories collapse helps in decluttering the index.
Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Next to read:
Managing Pages
On This Page
Structuring DocumentationIndex Depth