Technical Writer how-to
How to Write a Step-by-Step Procedure
Clear procedures help users succeed.
Quick answer
Clear procedures help users succeed. In short: identify; list; write, then complete the remaining steps below.
Step by step
Identify the user and goal.
List prerequisites.
Write one action per step.
Start steps with verbs.
Add screenshots where helpful.
Test the procedure yourself.
Safety reminders for technical writers
- Protect confidential product information
- Ensure safety warnings are accurate
- Use ergonomic setups
- Follow accessibility guidelines
Key terms
Documentation · Style guide · Information architecture · API · Docs as code · Single sourcing: see the full technical writer glossary.
