Writing practice / How-to
Write a procedure people can follow
Use prerequisites, numbered actions, and visible success checks.
Before you start
State the goal, required role, supported environment, and any input the reader must prepare. Put consequential warnings before the action they concern. Avoid prerequisites that are merely useful background.
Build the procedure
1. Give the procedure a task title. 2. List actions in execution order. 3. Start each step with a direct verb. 4. Match interface labels exactly. 5. Add the expected result after a significant action. 6. End with a clear completion check and a relevant next step.
Example: export a report
Illustrative product example: In Reports, open Monthly activity. Select a date range. Select Export CSV. When the file is ready, select Download. Open the file and verify that its first and last dates match your selection. These labels are examples, not instructions for a real product.
Test the draft
Ask a colleague with the stated permissions to follow the steps in a clean environment. Record missing context and unexpected results. Change the procedure to reflect observed behavior, then have the owner verify the final version.
Sources & further reading
Original guidance and examples by TechWriter, informed by these resources.