Use Descriptive Headings

DOCS-USE-DESCRIPTIVE-HEADINGS

Summary

Write headings that name the section content, destination, or decision area. Reserve imperative headings for procedures where the section is truly a step.

Rule

Use headings that describe the section content instead of slogan-like instructions or directions.

Why

Headings are navigation. A heading like "Choose the narrowest rule family first" sounds forceful but does not name the kind of information below it. A heading like "Start here" directs the reader without naming the destination. Readers and agents need to infer whether the section is about rule domains, usage flow, review policy, or setup. A descriptive heading such as "Rule domains" or "Review policy" gives the page a clearer scan path.

Helps

  • Makes pages easier to skim, search, link, and navigate non-linearly.

Limits

Imperative headings can work in procedures, checklists, and tutorials where the section is literally one step in a task. Prefer descriptive headings on reference pages, indexes, landing pages, and review guidance where the reader is choosing from named destinations or decision areas.

Agent Instruction

Use descriptive headings for reference and landing pages so the heading names the destination,
content, or decision area, not a slogan-like instruction or next-step direction.

Mechanisms

Supported by heading review, table-of-contents review, rendered-page inspection, and feedback that asks what a reader can learn from the heading alone.

References