Technical Writing
Technical Writing Formatting
Formatting isn't decoration — it's how a reader navigates a document. Good formatting lets someone find the step they need in three seconds. Practice these techniques and any document you produce will read like it was written by someone who knows what they're doing.
The formatting toolbox
- Headings for major sections (e.g. Purpose, Steps, Notes)
- Numbered lists for steps that must be done in order
- Bulleted lists for items that don't have a fixed order
- Bold for the exact button, menu, or field a reader clicks
- Warnings for anything that would cause loss or harm if ignored
- Notes for helpful context that isn't a step
A formatting drill
Take an unformatted paragraph, add headings and lists, mark the warning, and add one note. That is one drill. The library contains dozens.
Try it
Practice this in a timed session.
Realistic source material, a task timer, and a scored result.
Related