Structure technical content by task
Start with what the page helps the reader accomplish. For a procedure, state prerequisites, list ordered steps, and show the expected result. For reference, expose the names, inputs, defaults, and possible effects users need to look up.
- Use a guide for a goal, a reference for lookup, and an explanation for the reasoning behind a decision. Link them when a reader needs to move from one to another.
- Use sentence case for labels and section titles. Put the distinction in the heading itself, such as “Verify the active theme” or “Component contracts.”