TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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.
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 & 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 & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-