Posted by: episystechpubs | March 19, 2018

Editor’s Corner: Describe One Way to Perform an Action

When writing instructions, you might find that there’s more than one way to complete an action. For example, there are at least five ways to save a Microsoft® Word document.

Some writers think that it’s best to give readers a lot of choices, but instructions like the following can be confusing:

Example: Click Save or press Ctrl+S or press F12 or click File > Save or click File > Save As.

Experienced users might be annoyed that you’re wasting time telling them how to do a simple action. Inexperienced users might be overwhelmed by the choices. Instead of quickly saving the file and moving on to the next step, they might stop to wonder which method of saving is best.

Pick a single method that will work for the largest number of readers. For example, if readers might be performing the task on a phone or tablet, avoid references to keyboard shortcuts. Similarly, if the Save button is hidden by default, choose a different method that will work for most people.

Always consider your audience. If your instructions are intended for experienced computer users, you don’t need to document every keystroke. High-level instructions like the following are fine for some readers:

Example: Save the file, and then upload it to the Public folder.

Ben Ritter | Technical Editor | Symitar®
8985 Balboa Avenue | San Diego, CA 92123
619-682-3391 | or ext. 763391 | www.Symitar.com

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google+ photo

You are commenting using your Google+ account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

w

Connecting to %s

Categories

%d bloggers like this: