RE: The 'user' in User Manual

Subject: RE: The 'user' in User Manual
From: Maggie_Secara -at- capgroup -dot- com
To: "Andrew Warren" <awarren -at- synaptics -dot- com>
Date: Fri, 2 Feb 2007 14:32:05 -0800

Andrew Warren wrote:

> Steve Cavanaugh wrote:
>
> > without explicitly identifying to whom I am
> referring, it is very
> > difficult to write a cohesive sentence about the
> procedure that I
> > want the user to follow. In these cases, I tend to
> say "The Test
> > Operator clicks here, the PC responds with this,
> the Unit Under
> > Test does that..."
>
> But if the manual's written for the Test Operator,
> the imperative-voice
> version -- "Click here. The PC responds with this,
> the Unit Under Test
> does that..." -- seems just as cohesive.

Actually, that situation is an excellent place for a table, with columns
for Operator, Your PC, and Unit Under Test, or whatever. Which gets you out
of the "you" problem and makes it easy for the user to follow.

Maggie

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList

Now shipping: Help &amp; Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help &amp; Manual: http://www.helpandmanual.com

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

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


References:
RE: The 'user' in User Manual: From: Andrew Warren

Previous by Author: Recommendations for creating storyboards?
Next by Author: RE: Letter of Recommendation
Previous by Thread: RE: The 'user' in User Manual
Next by Thread: RE: The 'user' in User Manual


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


Sponsored Ads