1. Home
  2. Docs
  3. Style Guide
  4. Documentation Structure
  5. Section Headers and Subheaders

Section Headers and Subheaders

Section headers and subheaders are crucial for breaking down content into manageable chunks. They guide the reader through the document and create a logical flow of information.

Hierarchy and Consistency

  • Use a clear hierarchy: Start with primary section headers (H1), followed by subheaders (H2), sub-subheaders (H3), and so on. Each level should be clearly distinguishable from the others through size, boldness, or numbering.
  • Be consistent with header styles: Ensure that all headers of the same level look identical throughout the document. This includes font size, weight, and whether they are numbered.

Numbering Sections:

  • Use numbered headers for structured documents: In documents where order or hierarchy is important, number your sections and sub-sections. 
  • Avoid unnecessary numbering: If numbering doesn’t add clarity, omit it and use bold text for headers.

Descriptive Titles:

  • Use descriptive and concise headers: Headers should clearly convey the content of the section. Avoid vague titles like “Miscellaneous” or “Other Information.” Example: Instead of “General Info,” use “System Requirements.”

Dos:

  • Maintain a clear header hierarchy
  • Use descriptive titles for headers

Don’ts:

  • Don’t use non-descriptive headers: Example: Avoid “Miscellaneous.”