A product manual is a guide to setting up, using, maintaining, and troubleshooting a product. It helps readers find the instructions for the job in front of them, identify the parts or settings they need, and check whether they’ve completed the task.
Writing a product manual starts with finding out what readers want to do and checking how the product works. A small assembly example shows how to turn those facts into instructions a first-time user can follow.
Find out what readers need to do
List the tasks readers come to the manual to complete. Ask people who use the product what they try first, what they already know, and where they get stuck. Support questions and observations from a first-use session can reveal missing tasks or steps that experienced staff take for granted.
A first-time owner of a desktop organizer may need to identify the parts and choose where the divider goes. A returning owner may only need to move the divider. Use familiar action verbs and the names the reader can match to the product. If a part name is unfamiliar, explain what the part looks like or where to find it.
Organize the manual around tasks
Use headings that tell readers what they can do. Fit the divider helps someone find an assembly task. Move the divider gives a returning owner a separate place to look. Put dependent tasks in the order readers carry them out, and give stand-alone tasks their own headings so readers can go directly to them.
Put setup information before the steps
State the applicable model, required parts and tools, and any starting conditions before the first step that depends on them. Number actions that must happen in sequence. Use bullets for inventories and other items that readers can scan in any order. Place a diagram where the reader needs it, name it in the relevant step, and state essential orientation or placement details in the text. Microsoft Style Guide on writing step-by-step instructions.
Rewrite an assembly procedure
The fictional DT-2 desktop organizer comes with one tray and one removable divider. The model number appears on a label under the tray. The front rim is marked FRONT. The tray has two pairs of slots, with one slot on each side wall in each pair. Both slots in the front pair are marked A, and both slots in the rear pair are marked B. The divider has a smooth top edge and a tab near the bottom at each end.
Before. Line up the insert and push it into the slots. Use the back ones if you want more space. Make sure it is in properly.
After.
Fit the divider in the DT-2 organizer
Check for DT-2 on the underside of the tray. You’ll need the tray, the divider, and a flat work surface. Assembly requires no tools.
| Position | Left wall | Right wall |
|---|---|---|
| Rear pair | B | B |
| Front pair | A | A |
- Set the tray on a flat surface with the FRONT mark facing you.
- Choose a matching pair of slots using Diagram 1. If you want a deeper front compartment, choose the rear pair marked B. If you want a deeper rear compartment, choose the front pair marked A.
- Hold the divider with its smooth edge up and line up one tab with each slot in the pair you chose.
- Slide the divider straight down until both tabs reach the bottoms of their slots.
Check the result. The divider stands upright, both tabs are fully seated at the same depth, and the tray has two compartments. If the divider sits unevenly or stops short, lift the divider straight out and check that both slots have the same letter before you try again.
Write each step as a direct instruction
- Give the reader an action. An imperative tells the reader what to do. Start each step with a verb such as set, choose, hold, or slide so the action is easy to find.
- State the condition first. In If you want a deeper front compartment, choose the rear pair marked B, the reader can decide whether the action applies before choosing a slot pair.
- Name the part when a pronoun could point to two things. In Check the tray and the divider before you move it, it could mean either part. In Slide the divider straight down, the object of the action is explicit.
For more examples of how to order a condition and an action in one sentence, see Google’s developer documentation guidance on sentence structure.
Check technical accuracy and consistency
Run the procedure on the model it names
Ask the product owner to confirm the model and revision, the parts list, and the expected outcome. Follow the draft from start to finish on that version of the product. For the DT-2, fit the divider in each pair and verify which compartment gets deeper. Confirm that the completion check matches what you can see on the assembled tray. If a later model changes a slot label or location, update the affected instructions and artwork and record which model each manual covers.
Match terms across the manual and product
Compare the parts list, steps, diagram, and troubleshooting text side by side. Use divider throughout if that’s the approved part name, and reproduce the markings FRONT, A, and B exactly. Check that every diagram reference reaches the right image or drawing. After layout, proofread the version readers will see and check that labels, references, and numbered steps survived the edit.
Watch a first-time reader use the manual
Give someone who has never used the DT-2 the two parts and the draft. Ask them to set up the organizer with more room in the front compartment. Leave the choice of slots to the reader. Note the heading they find, the slots they try, any rereading or requests for help, and how they decide they’ve finished. After the task, ask what they looked for when choosing a pair. GOV.UK guidance on observing readers as they complete a task.
In a mock session with the first draft, a reader tries the rear slot on the left and the front slot on the right, then asks why the divider won’t slide in. Put the matching-letter instruction and the diagram at the point where readers choose a pair. On the next round, see whether a new reader selects both B slots and checks that the tabs are fully seated without help.
Try six product manual edits
Use the DT-2 facts and procedure to edit each line or plan a check.
- Task heading. Replace Divider information with a heading for the installation steps.
- Prerequisite. The model check appears after the last step. Move it to where the reader needs it and tell them where to look.
- Condition. Rewrite Choose the rear pair marked B if you want a deeper front compartment.
- Unclear pronoun. The divider is the part that moves. Rewrite Once the divider lines up with the tray, slide it down until it is in place. Name the moving part and give a visible stopping point.
- Accuracy and consistency. The DT-2 parts list calls the part a divider. A draft caption says The insert sits in the front slots marked B. The caption is meant to show the divider in the front pair. What needs to change?
- Usability. A first-time reader picks the correct slots but asks how far down to slide the divider. What would you clarify and watch for on the next trial?
Show answers and explanations
- Fit the divider. The verb names the task and the object tells the reader which part it involves.
- Before the numbered steps, write Check for DT-2 on the underside of the tray. The reader can confirm the procedure applies before using it.
- If you want a deeper front compartment, choose the rear pair marked B. The opening clause tells the reader when to take the action.
- When the divider’s tabs line up with the slots, slide the divider straight down until both tabs reach the bottoms of their slots. The sentence preserves the starting condition, names the moving part, and gives a stopping point the reader can check.
- Write The divider sits in the front pair marked A. The caption uses the approved part name and the actual front slot label. Check that the illustration also shows the divider in the front pair.
- Add the stopping point to the action step. Ask a new reader to complete the same task. Observe whether they stop with both tabs fully seated and can identify that result on their own.
Review the manual before release
Have the product owner check the final manual against the release version. Recheck any steps or diagrams you changed after reader testing. Record the model and manual revision on the published copy so support staff can match the instructions to the product a reader has. Give readers a way to report unclear instructions and ask which model and manual revision they used.
Related writing guides
- Turn recurring support questions into direct answers readers can find. How to Write Effective FAQs.
- Give the final copy a focused review for language and formatting. The Art of Proofreading in Three Passes.
