Skip to content

Chapter 2 of 7

Document Structure and Information Design

Strong documents move the reader from context to steps to examples to troubleshooting in a logical order, and the way the page is shaped matters as much as the words on it. Headings are the spine: they help readers find the right section quickly, communicate the content hierarchy, and act as the table of contents that scanners rely on. Headings should descend without skipping levels, with one H1, H2s for top sections, and H3s inside H2s, so navigation and screen readers stay honest. Titles should start with a noun or verb ("Configure SSO," "Authentication overview") rather than an article, because they sort and read more cleanly. The first sentence after the title, often called a landing sentence, should preview what the page accomplishes so scanners can confirm they are in the right place.

Different kinds of writing call for different shapes. Procedural writing gives step-by-step instructions for a task and works best in the imperative mood, with each step short, numbered when order matters, and parallel so items read as peers. Conceptual writing explains how something works or why it matters before asking the reader to act. An effective summary sentence tells the reader what the section will help them accomplish, while each paragraph should advance a single idea so a reader who skips a paragraph never misses a separate point buried inside it. Short paragraphs, action-oriented headings, and progressive disclosure that reveals the simplest useful guidance first, then deeper detail only when needed, all support the way most readers actually consume technical content. The F-shape reading pattern, in which eyes sweep horizontally across the top and then in shorter sweeps lower down, is fed by headings, lists, and bold cues that match the way readers scan.

Several reusable patterns show up across strong docs. The inverted pyramid puts the most important conclusion or instruction first, then expands with context and ends with background or edge cases, and it works at the page level and inside a single paragraph. Scannability is not a stylistic flourish; most readers scan before reading deeply, especially when troubleshooting under time pressure. Callouts (note, tip, warning, danger) highlight information that would be dangerous to miss, with warnings reserved for actions that can cause data loss, security holes, or irreversible damage and notes for useful context that is helpful but not dangerous. Prerequisites sections tell the reader exactly what they must already have, know, or configure before the instructions will work. A TL;DR at the top of a long page, an overview that sets context, a topic sentence at the head of each paragraph, a colon introducing a list or code example that elaborates on the preceding clause, and a troubleshooting section that anticipates common failures all reduce the cognitive load of getting to the right answer quickly.

All chapters
  1. 1Foundations of Technical Writing
  2. 2Document Structure and Information Design
  3. 3Examples, Code, and Visual Communication
  4. 4Specialized Document Types
  5. 5Site Architecture, Navigation, and Search
  6. 6Quality, Review, and Maintenance
  7. 7Docs as Code, Tooling, and Continuous Delivery

Drill it

Reading is not remembering. These come from the Technical Writing deck:

Q

What is technical writing?

Technical writing is the craft of explaining complex information clearly so readers can understand and act on it.

Q

Why is technical writing valuable?

It reduces confusion, improves adoption, and helps teams scale knowledge beyond live conversations.

Q

Who is the audience in technical writing?

The audience is the specific reader or user the document is trying to help, persuade, or guide.

Q

Why should technical documents start from user need?

Clear documents answer the reader’s real question instead of showcasing everything the author knows.