Process improvement · 7 min read

Turning a long document into a guided procedure

You do not need to start from scratch. An existing document already contains most of a guided procedure; the work is in separating actions, decisions, exceptions and background.

1. Mark up the document

Go through the document once with four colours: actions (something a person does), decisions (something that changes the path), exceptions (unusual cases) and background (why, context, definitions). Most long documents are more than half background.

2. List the actions in order

Write the actions as a numbered list of short, verb-first steps. Do not worry about branches yet. If two actions always happen together, combine them.

3. Insert the decisions

Place each decision just before the first action that depends on it. Give each answer a label and connect it to the action it leads to. Add an ending for each branch.

4. Attach exceptions and sources

Move each exception onto the step it affects. Add a source reference, such as the section of the original document, so people can check the detail if they need it.

5. Keep only the background that helps

Turn the useful parts of the background into short notes at the point they matter. Leave the rest in the source document, linked from the procedure.

6. Test with someone new

Ask someone unfamiliar with the process to follow the draft on a real or sample case. Every place they hesitate is a step to rewrite. Then send it for review and approval.

SI-assisted conversion is on the Ask Compass roadmap. When it arrives, it will produce a draft with source citations for a person to review; it will not publish anything on its own.