7-Step Approach to Proofreading User Guides

What can Kate Winslet teach you about proof-reading technical documents?

Watch the movie The Reader and it will make sense.

One of the biggest mistakes you can make when revising any technical document, is to do it all in one go. You can’t!

7 Ways to Proofread User Guides

Make it easy on yourself and focus on one area at a time. Instead of revising the document in one session, break out the tasks and revise the document by task.

For example, start with checking the facts, then the spelling, how the document flows, cross-references, footers, index entries and so on.

#1 Overview

In the opening section, do you have a statement, a sentence or two that states the main point or argument of your document?

Likewise, is there a conclusion that ties together all the points made in your document?

#2 Tasks

Does your user guide address the user’s requirements?

Check the document to see if you addressed each task and provided enough information for the user to perform the task.

#3 Structure

Does the document flow? Make sure each topic connects clearly and logically. Do the topic sentences of each paragraph relate to the subject matter?

#4 Accuracy

Is the information correct?

Is it adequately documented?

Have you tested the document so that it helps the reader to perform their tasks?

#5 Language

Do you use specific language? Avoid vague terms such as in the event of, thing, factors, and over reliance on unclear pronouns like “this” and “it.”

#6 Drafts

Technical Writing involves writing multiple drafts. This means that after each draft, you need to check that the edits have been included in the correct draft.

#7 Read Aloud

Get into the habit of reading your documents aloud.

If you have trouble reading a sentence clearly and smoothly, it probably needs to be rewritten.

And if it sounds wrong to your ear, then that’s a warning sign that something needs to be corrected.

PS – I also use a checklist to check off the different tasks as I revise technical document. This is especially helpful if you’re working late or are revising several documents in succession.

One mistake to avoid is to focus on one area, for example spelling, and overlook other areas, for example, the accuracy of the material.

While the reader may forgive you for the occasional spelling mistake, they won’t be impressed if the material itself is incorrect.

How do you revise your documents? What mistakes do you see most often?

User Guide Templates

Download Now for $9.99 – Buy Here!

Download Template

Includes the following templates

Learn more about these corporate User Guide Template

Learn more about this modern User Guide Template

Learn more about this User Guide Templates

Learn more about these User Guide Templates

Thousands of templates to jump start your project

Acceptance Test Plan

Contingency Plan

Software Development Templates

Acquisition Plan

Conversion Plan

Software Requirements Specification

Action Plan

Cost Benefit Analysis

Software Testing

API Documentation

Database Design

Standard Operating Procedures (SOP)

Audience Analysis

Datasheet

Statement of Work

Availability Plan

Deployment Plan

System Administration Guide

Bill of Materials

Design Document

System Boundary

Business Case

Disaster Recovery Plan

System Design Document

Business Continuity

Disposition Plan

System Specifications

Business Plan

Documentation Plan

Technical Writing Templates

Business Process

Employee Handbook

Test Plan

Business Requirements

Error Message Guide

Training Plan

Business Rules

Expression of Interest

Transition Plan

Capacity Plan

Fact Sheet

Troubleshooting Guide

Case Study

Feasibility Study

Use Case

Change Management Plan

Functional Requirements

User Guide

Communication Plan

Grant Proposal

Verification and Validation Plan

Concept of Operations

Implementation Plan

White Papers

Concept Proposal

Installation Plan

Work Instructions

Configuration Management Plan

Interface Control Document

Software Development Templates

Acceptance Test Plan

Maintenance Plan

Software Requirements Specification

Acquisition Plan

Market Research

Software Testing

Action Plan

Marketing Plan

Standard Operating Procedures (SOP)

API Documentation

Needs Statement

Statement of Work

Audience Analysis

Operations Guide

System Administration Guide

Availability Plan

Policy Manual

System Boundary

Bill of Materials

Project Plan

System Design Document

Business Case

Proposal Manager Templates

System Specifications

Business Continuity

Proposal Template

Technical Writing Templates

Business Plan

Quality Assurance Plan

Test Plan

Business Process

Release Notes

Training Plan

Business Requirements

Request for Proposal

Transition Plan

Business Rules

Risk Management Plan

Troubleshooting Guide

Capacity Plan

Scope of Work

Use Case

Case Study

Security Plan

User Guide

Change Management Plan

Service Level Agreement (SLA)

Verification and Validation Plan

Communication Plan

Setup Guide

White Papers

Concept of Operations

Social Media Policy

Work Instructions

Concept Proposal

Contingency Plan

 

Configuration Management Plan

Conversion Plan