Why instructions fail
When you know a task well, many steps feel too obvious to mention. You skip them without noticing. The reader, who lacks that background, gets stuck at exactly those points and has to ask, or guesses and gets it wrong. This is sometimes called the curse of knowledge: it is hard to remember what it was like not to know something.
Good written instructions make up for that gap. They let someone complete the task alone, at their own pace, and they save you from answering the same questions again. They also give you something to improve, which a verbal explanation does not.
The ideas here are general. If your workplace has required formats for procedures, such as safety or compliance steps, follow those and check your employer’s rules.
Decide who will read them
Before writing, picture the person who will follow the steps. A coworker who knows the system needs less than someone brand new. If you are unsure, write for a smart person who is new to this specific task. Over-explaining slightly is usually less costly than leaving people stranded.
Also decide how the instructions will be used. Will someone read them once and then work from memory, or follow along step by step each time? The second use calls for short numbered steps. The first can have more explanation.
Start with the purpose and the result
Open with one or two sentences: what the task is for and what the finished result looks like. This helps the reader make sensible choices when something unexpected comes up. A person who knows the goal can handle small surprises without asking.
Then list what they need before starting: access, files, tools, information and roughly how long it takes. Missing prerequisites are a common source of questions, and it is frustrating to be halfway through before discovering you lacked something.
Write the steps
A few habits make steps easier to follow:
- One action per step. “Open the folder, copy the file, rename it and send it” is four steps.
- Put them in the order they happen. Do not make people jump around.
- Start each step with a verb. “Select,” “enter,” “save.”
- Use the names people will actually see. If the button says “Submit,” do not call it “the send option.”
- Be concrete about amounts and limits. “Wait a moment” is vague; “wait until the status changes to Complete” is clear.
- Say what should happen. “You should now see a confirmation message” lets the reader know they are on track.
Keep sentences short and avoid jargon unless the reader already uses it. If you must use a special term, explain it once.
Show an example
A short worked example is often worth more than a paragraph of description. Show a filled-in version of the finished product, a sample entry or a before and after.
For instance, if you are explaining how to name files, show one correct name and one incorrect one with the reason. Following a good file naming pattern is far easier when there is an example to copy. Be careful with examples, though. People may copy them literally, so choose one that is typical, and if there are variations, say which parts can change.
Cover the common problems
Think about where people are most likely to go wrong, and address it right in the steps or in a short section at the end. Useful items include:
- the mistake that happens most often and how to fix it
- what to do if a step does not work as described
- who to contact if they are stuck, and when it is reasonable to do so
- decisions they can make on their own and those that need approval
This links to how much authority you are giving. If the person can decide something, say so. If an exception requires your input, describe how to reach you. Good task delegation includes this kind of boundary.
Keep them short enough to use
Long, dense documents do not get read. Use headings if the task has distinct phases, short paragraphs and white space. Put the most important warnings before the step where they matter, not in a note at the bottom.
Consider where the instructions live. A single shared location that everyone knows about is better than scattered copies. A sensible approach to file organization means people can find the latest version, and a date or version note at the top shows how current it is.
Test them
The most reliable way to improve instructions is to watch someone follow them. Ask a person who has not done the task to try, and stay quiet while they do. Note every place they hesitate, ask a question or do something unexpected. Each one is a gap to fix.
If you cannot find a tester, set the instructions aside for a day and reread them as if you were new, or follow them yourself exactly as written, without relying on memory. You will often discover a missing step.
Keep them current
Instructions go stale. When someone finds a better way or something changes, update the document, and invite readers to point out problems. Learning from mistakes applies here too: when a question comes up twice, treat it as a sign the document is missing something.
A simple template that works for many tasks:
- Purpose and finished result
- What you need before starting
- Numbered steps, one action each
- An example
- Common problems and who to ask
Instructions do not have to be perfect on the first try. A rough version that gets tested and improved will serve people better than a polished one that never gets written.