How-to guide
How to make a procedure scannable
Problem: Instructions are buried in descriptive prose and readers miss steps.
Use when: Runbooks, setup guides, onboarding docs, support articles.
Steps
- Cut prefatory background; get to the first real action fast (minimalism).
- Cast each step as a numbered imperative: one action per step, in order.
- State any condition before its action: “If prompted, enter the code.”
- Separate the why (concept) and the what (reference) into their own sections.
Example
Descriptive proseThe configuration would then be saved by the user, after which the service can be restarted, assuming credentials have been entered.
Scannable procedure1. Enter your credentials. 2. Click Save. 3. Restart the service.