Summary
Highlights
Instructions are a sequence of steps explaining how to do or complete a task. Readers vary in their approach to instructions, some reading carefully, others attempting tasks without full review, and some preferring graphics. Understanding the procedure through flowcharts, working backward, observing, and interviewing is crucial before writing.
Instructions typically include steps and explanations, with optional additions like cautions, definitions, introductions, tool lists, graphics, notes, and warnings. Formatting should prioritize readability for impatient users through ample white space, numbered lists (one item per step), and clear graphics like flowcharts or diagrams.
Instructions must be in chronological order, using numbers or letters for sequencing. Steps should be actions in imperative mode (command verb and object), with only one instruction per step. Use clear, specific language, and place detailed explanations or sub-steps after the main step to elaborate on what to do, why it's important, and how to perform the action.
Field testing involves having different people try out your instructions to get feedback on clarity, sequence issues, or missed steps. Two types of field tests are concurrent testing (evaluating while performing) and retrospective testing (answering questions after completion).
Online instructions often use a layered approach, with basic steps on one page and links to more detailed information. When writing online instructions, follow print guidelines but also limit each unit to one screen, use consistent design, provide site maps and navigation aids, include keyword searches with synonyms, and field test their usefulness and accuracy.