Skip to content
STE Guide

User Manual Examples: Before-and-After Rewrites and Tests

Published · Updated

User Manual Examples: Before-and-After Rewrites and Tests

A technician stops work at a pump. The manual says to service the filter as necessary. The technician doesn't know which valve to close, which part to remove first, or how to confirm success.

That pause is common. Many user manual examples show clean layouts but leave actions, conditions, and results unclear. The examples below use a stricter test. Each sentence names an action, an object, and an observable result.

Table of Contents

Before and After Rewrites of Manual Examples

Rewrites show a writing problem more clearly than an abstract rule. In a 1997 usability study of a patient-administration system manual with 30 nurses, nurses who used a revised manual completed tasks 21% faster than nurses who used the original, according to the 1997 usability study of the patient-administration manual. They also issued fewer ineffective commands. The gain came from testing, revision, and clearer task wording.

The table compares four weak sentences with direct rewrites. Each rewrite removes a guess that the reader would otherwise supply.

Original sentence Problem Rewrite
Service the filter as necessary. No conditions, no sequence and no completion check Stop the pump. Close valve V-12. Remove the filter cover. (Remaining steps in the procedure section.)
Tighten the connector correctly. 'Correctly' gives no measurable endpoint Align the connector with port A. Turn the coupling nut clockwise by hand until it stops. Tighten the nut to 12 N·m. Confirm the alignment mark is within the inspection window.
Utilize the appropriate apparatus. Long word and vague noun Use the correct tool.
The system may not start. Restart it. Vague cause and no stop condition If the indicator does not appear, stop. Check that the power switch is on.

The Pattern Behind the Rewrites

Each rewrite does four things. It names the control. It states the prerequisite state. It gives one action per sentence. It states an observable result.

The filter rewrite names the pump, valve V-12, and cover. The connector rewrite replaces an opinion, correctly, with a torque value and a visual check. The tool rewrite uses a shorter common word, the kind listed through the ASD-STE100 dictionary page. The start rewrite names the indicator and tells the reader when to stop.

All examples on STE Guide are its own, and STE Guide doesn't copy the rules or dictionary of the official specification. Writers therefore see the method without a copied rule text. That limit keeps the explanation separate from the authoritative source.

Practical test: A strong instruction names the verb, the object, the prior condition, and the visible result.

A writer can test any sentence with four questions. What's the verb? What's the object? What must be true first? What does the reader see when the step succeeds? If one answer is missing, the sentence isn't complete.

Using Semicolons Correctly in Technical Instructions

A semicolon joins two independent clauses that relate closely. An independent clause can stand alone as a sentence. A semicolon also separates list items that already contain commas.

Both uses are valid in general English. Manual writing adds a tighter concern. A semicolon can put two actions in one sentence and make the second action easier to miss.

Use Correct example Incorrect example
Join two closely related independent clauses The pump is off; the valve is closed. The pump is off, the valve is closed.
Separate list items that contain commas Parts: seal kit, 2 pieces; filter, type B; cover, grey. Parts: seal kit, 2 pieces, filter, type B, cover, grey.
Join clauses linked by a conjunctive adverb Check the seal; therefore, replace it if damaged. Check the seal, therefore replace it if damaged.

Comma Splices and Adverb Punctuation

The incorrect first row is a comma splice. It joins two independent clauses with only a comma. Readers may run the clauses together and miss where the first condition ends.

A conjunctive adverb such as therefore needs a semicolon before it and a comma after it. The pattern is clause, semicolon, adverb, comma, clause. A comma alone before therefore doesn't separate the clauses strongly enough.

Two mistakes occur often. The first puts a semicolon before a dependent clause, such as a fragment that can't stand alone. The second uses a semicolon where a period gives a clearer instruction boundary.

The Manual Writing Decision

Consider this draft sentence: Close valve V-12; remove the filter cover. Both clauses are instructions. Each clause can stand alone.

If the second clause can stand alone as an instruction, a period is usually clearer than a semicolon.

Separate sentences give each action its own line or step. That structure helps scanning, translation, and error recording during a user test. It also keeps one action from hiding after a punctuation mark.

Writers can review sentence boundaries through the punctuation writing rules. More punctuation appears in context on the examples material, while the ASD-STE100 PDF reference page points toward the official specification. The official specification gives the exact punctuation rules. When STE Guide's explanation and the official specification differ, the official specification is correct.

How to Write a Task-Based Procedure Step by Step

A task-based procedure supports physical action and decisions. The NASA human integration design handbook treats task analysis as the definition of physical and cognitive work, including perception, decision-making, comprehension, and monitoring. It also supports usability testing and repeated task-analysis reviews.

Each numbered step therefore maps to one observable action. The final step confirms that the task worked. The structure below helps a writer build that sequence.

A woman sketching a six-step process for a technical writing user manual guide on a white wall.

Six Writing Steps

  1. Name the goal and required condition. State the task result first. State conditions such as pump stopped and valve closed before work starts.
  2. List observable cues. Name what the reader sees, hears, or checks before acting. A cue helps the reader confirm the starting state.
  3. Write one action per step. Name the control in each step, such as valve V-12. Don't combine valve closure and cover removal in one sentence.
  4. Add the expected result. After an action changes the system state, state the result. The reader then knows whether to continue.
  5. Place verification at the end. Give a final check, such as a leak check. The check provides feedback that the task succeeded.
  6. Review against the actual task order. Compare each written step with the real sequence. Remove any step that depends on knowledge the manual doesn't give.

Detailed structure for this kind of content appears in the procedure writing rules. The worked example below applies the six steps to filter replacement.

Worked Example for Filter Replacement

Replace the filter

Condition: The pump is available for maintenance.

  1. Stop the pump.
  2. Close valve V-12.
  3. Remove the filter cover.
  4. Install a new filter.
  5. Open valve V-12.
  6. Start the pump.
  7. Check for leaks.

Step 2 comes before step 3 for a clear reason. Closing the valve isolates the filter section before the cover comes off. Reversing steps 2 and 3 changes the task state during cover removal.

Step 5 restores flow after installation. Step 6 then restarts the pump in the restored configuration. Step 7 closes the task with an observable check, rather than an assumption.

Common Slips and the Finished Form

Three slips weaken this simple example. A writer may reverse steps 2 and 3. A writer may combine two actions in one sentence. A writer may omit the leak check.

Completion rule: A procedure isn't complete until the reader has a way to confirm the result.

On the page, a complete procedure has four parts. The title states the task. The conditions line states the starting state. The numbered actions give the sequence. The closing check confirms success.

Stress, distraction, and fatigue can reduce comprehension. A fixed sequence reduces the need to infer missing order. That benefit is central to effective user manual examples for maintenance work.

Failure Paths Every Manual Example Should Cover

Most manual examples show the ideal flow. A reader follows each step, gets each result, and finishes. Real work includes a missing indicator, a closed valve, or a leak after restart.

The first need at that moment is a decision point. The text should say whether to continue, stop, check a condition, or repeat a step. A vague restart instruction doesn't answer that question.

Six Failure Types

  • Failed start: The expected indicator or motion doesn't appear.
  • Missing prerequisite: A required tool, part, or system state isn't present.
  • Wrong mode: The equipment is in a mode that blocks the task.
  • Interrupted process: Power, access, or work stops before completion.
  • Unsafe condition: The observed state creates a hazard or damage risk.
  • Version mismatch: The part, interface, or software state doesn't match the procedure.

Each type needs a stop condition. The sentence "If the indicator does not appear, stop" prevents blind repetition. It also gives the reader permission to leave the main sequence.

Symptom Likely cause Recovery instruction
Indicator light does not appear Power switch is off If the indicator does not appear, stop. Check that the power switch is on.
Pressure does not rise after start Valve V-12 is closed Stop the pump. Open valve V-12. Start the pump again.
Torque wrench clicks before 12 N·m Wrong socket or damaged nut Stop. Replace the socket or nut. Repeat the torque step.
Leak appears after restart Seal not seated Stop the pump. Reseat the seal. Repeat the leak check.

Symptom, Cause, and Recovery

A symptom is what the reader observes. A cause is the condition behind that observation. Keeping those ideas separate prevents a fix from resting on a guess.

The recovery pattern has four parts. Stop first, state the check, state the fix, and state how to repeat the step. Each part uses a short action sentence.

A warning belongs before the step it applies to. A warning after the hazardous action arrives too late. Its placement is therefore part of the task sequence, not page decoration.

Unclear recovery text creates support requests, maintenance risk, and safety exposure. Failure paths need the same controls, conditions, and observable checks as the main procedure.

Accessibility and Translation Checks for Manual Examples

Simple wording helps many readers. It doesn't by itself make a manual accessible or translatable. Layout, labels, image text, and regional formats still affect use.

Accessibility research applying WCAG 2.2 identifies recurring problems including low contrast, small touch targets, missing alternative text, and incorrect form labels, according to the WCAG 2.2 accessibility research. Manual examples should show how wording and presentation handle those problems together.

Four Side-by-Side Cases

  • Visual step for screen-reader users: Replace "click the green button on the right" with a named control, sequence position, and result. For example, "Select Start. The status changes to Running."
  • Warning without color alone: Start with the text label WARNING. State the hazard, then state the required action.
  • Caption that survives translation: Name the control in the caption and body text, not only inside the screenshot. Leave space for longer translated labels.
  • Regional numbers and dates: Put the unit beside every value. Avoid date forms that readers in another region can reverse or misread.

Each rewrite serves a defined reader need. The screen-reader version removes location and color as the only identifiers. The warning version remains clear in grayscale and in spoken output. The caption and value versions keep meaning outside one image or local convention.

Checks Before Translation

Editors should use logical heading order. Images need meaningful alternative text. Each interactive step should work with a keyboard only.

Terminology review should occur before translation starts. Interface labels should match the translated product text. Local date and number formats should be checked in the final layout.

Simplification is necessary, but it doesn't automatically make content accessible or translatable.

Strong user manual examples show both versions side by side. Readers can then compare the source instruction, the accessibility change, and the translation risk. That comparison exposes problems a clear-sentence check may miss.

Test Your Manual Examples Before Release

The official specification remains the reference point. ASD-STE100 Issue 9 was released on January 15, 2025 and is the current issue. Exact rule and section counts can change between issues, so check the official specification. STE Guide is a free, independent educational website that explains ASD-STE100 in its own words and doesn't replace that specification.

A Short User Test

Testers should be representative users, not the writer who drafted the example. The test records task-success rate, time on task, and error frequency by step. It also records the exact sentence that caused hesitation.

That sentence gets rewritten first. The revised procedure then goes through another test. Repeated testing shows whether the change removed the problem or moved it to a later step.

Release Checklist

  • Sequence: Is the sequence unambiguous?
  • Result: Is every critical result observable?
  • Sentence load: Does each sentence hold one action?
  • Failure: Are the necessary failure paths covered?
  • Access: Do the accessibility and translation checks pass?

A draft can receive a quick first pass through the free STE checker. The checker is heuristic, can miss problems, and can flag correct text. Rule summaries on the writing rules page and models on the ASD-STE100 examples page support the human review.

The release action is direct. Run the draft through the checker, correct clear problems, and test the result with a real user.


STE Guide offers free explanations, original rewrites, and drafting tools for writers who need clearer manual procedures. Those resources help turn vague instructions into observable steps, failure paths, and testable checks. Visit STE Guide to apply the method to the next draft before formal review.

Related articles

Check your technical text with the free STE Checker.

Open the STE Checker

Writing Rules →

Explore the eight writing-rule categories.

Examples →

Original before-and-after STE rewrites.

STE Checker →

Check your technical text.