Which style of giving instructions is more effective?

Subject: Which style of giving instructions is more effective?
From: Heidi Bailey <hbailey -at- ocztechnology -dot- com>
To: "ryan -at- clicksecurity -dot- com" <ryan -at- clicksecurity -dot- com>
Date: Thu, 20 Dec 2012 00:51:14 -0800

Many of us were taught that you tell them what they're gonna do, then tell them how.
So in your example, "To restart the device, enter the following command:" is the correct form.

Same with things like cross references: "To learn more about Blah, see chapter 6, Blah Blah on page n."

This level of consistency is definitely good and desirable - the fewer sentence patterns a user has to churn through, the quicker they read and find what they need...

Heidi



Technical Author
OCZ Technology Ltd
25 Milton Park
Abingdon
Oxfordshire
OX14 4SH
Registered in England no 7806324
Registered Address: As Above
Tel: +44 (0) 1235 824900
Fax: +44 (0) 1235 821141
Email: hbailey -at- ocztechnology -dot- com
Web: http://www.ocztechnology.com

---------------
Hi all,

I'm debating the merits of two different styles of commands:

"Enter the following command to restart the device:"

(followed by the command itself)

and

"Restart the device by entering the following command:"

(followed by the command itself)

I've been flipping back & forth on these for years; now that I am creating
a new documentation set, I'd like to be consistent, if that is even
possible (or desirable).

Any thoughts on the relative merits of each style? Situations when either
would be useful? etc.

Thanks for your input!

--

Ryan Pollack
Senior Technical Writer | Click Security


CONFIDENTIAL COMMUNICATION: This communication including any attached file(s) is CONFIDENTIAL, intended only for the named recipient (s) above and contains trade secrets or other information that is exempt from disclosure under applicable law. Any use, dissemination, distribution or copying of this communication and any file attachments by anyone other than the named recipient (s) is strictly prohibited. If you have received this communication in error, please immediately notify us by reply electronic mail and permanently delete the original transmission and any attachments from your computer system and any copies of this message and file attachments. Thank you.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Writer Tip: Create 10 different outputs with Doc-To-Help -- including Mobile and EPUB.

Read all about them: http://bit.ly/doc-to-help-10-outputs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: Digital voice recorder is priceless
Next by Author: RE: Which style of giving instructions is more effective?
Previous by Thread: RE: Which style of giving instructions is more effective?
Next by Thread: RE: Which style of giving instructions is more effective?


What this post helpful? Share it with friends and colleagues:

Sponsored Ads


Sponsored Ads