Why Short Procedures Work Best… sometimes

sop-short-procedures

If you are new to writing procedures there can be a temptation to dress up the language of the SOP to disguise your lack of experience or make the procedure sound more ‘professional’.

The opposite usually happens. The procedure sounds stiff, doesn’t flow, and is often unreadable. Instead, use short words, keep to the point, and help the reader understand the procedure as quickly as possible. In addition, avoid using jargon or industry speak that will confuse reader. And remember that are not everyone reading your procedure is not a native English speaker avoid using phrases or figures of speech that will trip people up. Aim for simplicity.

  1. Long v Short words – if you have a choice, use short monosyllable words rather than more complex, impressive sounding words. For example, use ‘get’ instead of ‘procure’. The meaning is that same.
  2. Redundant phrases – if you change phrases such as ‘in the event of’ and use ‘if’, the meaning remains the same. Other fillers include ‘at this point in time’, which can usually be deleted and have no impact on the integrity of the procedure.
  3. Fillers – phrases such as just now, simply click, and due to the fact that, can be changed to now, click, and because without changing the meaning of the text. Look for fillers like these in your text and also legacy materials that need to be updated.
  4. You v User – this may depend on your in-house style guide, but it’s worth considering how you address the reader. If you use ‘you’ when talking to the reader, it creates a more immediate impact. However, if you overdo it, it can sound too informal and chatty. Likewise, if you refer to ‘the user’ all the time, it can sound harsh and cold. After all, the reader is the user. Referring to the reader in the third person tends to distance them from you, the writer. So, before you start, consider the tone and phrasing you want to adopt. Then be consistent across all documents.

What’s important here is not whether the procedure is long or short. Instead, look for ways to explain how the procedure works as clearly as possible. In most cases, this means using simple, direct, and concise language. Get past trying to impress the reader – or your boss – and zero in on the task.

Get free and premium MS Word, Excel and Apple templates today


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