Re: Software Manuals

Subject: Re: Software Manuals
From: "Stephanie Bryant" <mortaine -at- gmail -dot- com>
To: "Johnson, Joyce" <JJohnson -at- abc-sg -dot- com>
Date: Tue, 17 Jul 2007 07:32:33 -0700

My client makes a similar product, Joyce (not a competitor, though) with a
similar audience.

We're currently doing online help only, because we don't find the
workstations are conducive to keeping a hard copy manual nearby. There's a
PDF of the help that users may print out and use if needed.

After speaking with our audience, I decided to include screen shots, but
make them optional. In other words, they can click to drop-down the picture,
or leave the instructions as text-based. The doctors and nurses did NOT want
to have the images completely gone, but they DID want them to be hidden
until called-upon.

I recommend you ask your audience. You and the other tech writer should
write up two prototypes and do a short document test with a nurse, a
pharmacist, and a pharmacy tech and find out. When I did my audience test,
the prototype had very few screen shots, and the users did not miss them
much-- they only missed them in the places where the UI is directly
described. However, when I asked, they said they would not want the help to
be completely image-free.

On 7/17/07, Johnson, Joyce <JJohnson -at- abc-sg -dot- com> wrote:
>
> The application is used with automated pharmacy dispensing hardware.
> Typical users are nurses, pharmacists, and pharmacy technicians.


--
Stephanie Bryant
Author, Videoblogging for Dummies
mortaine -at- gmail -dot- com
http://www.mortaine.com/
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.
http://www.DocToHelp.com/TechwrlList

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com

---
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-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.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/ for more resources and info.


References:
Re: Software Manuals: From: Caroline Tabach
RE: Software Manuals: From: Johnson, Joyce

Previous by Author: Re: Ethics of Jumping To Another Contract Job
Next by Author: RE: Spell-checking text entered in MS Word forms?
Previous by Thread: RE: Software Manuals
Next by Thread: RE: Software Manuals


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


Sponsored Ads