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: Medical Software Industry From:"Sonja Marnewick" <Sonjam -at- medemass -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 10 Nov 2004 09:37:52 +0200
Sarah Stegall wrote:
>Sonja: I used to work in the medical software industry, particularly in
software designed to translate medical images >(X-rays, CAT scans, etc.)
from analog to digital format so that it could be analyzed for anamolies
(in diagnosing
>cancer, for example).
>The best piece of advice that I can give you is to know your audience.
If you are writing a manual for, say,
>radiological technicians, keep in mind that this audience typically has
lots of experience, a very high turnover rate,
>almost NO time to read manuals, and rarely has a four-year college
degree. We focused on streamlined instructions,
>"cheat sheets" placed next to a machine, decals and stickers ON the
machine, and a manual that was designed as
>a flip-chart with LOTS of illustrations. Please understand that I am
not saying you should "dumb down" a manual,
>only that you should respect the users' time and experience.
Sarah: Thank you so much for your input. This has been extremely
helpful.
Just a few notes:
My audience seem to be the receptionists, and bookkeepers, not really
the Doctors, as they all have people running their practices, from a
reception and accounting point of view (which is essentially what our
software is about)
Writing on a high level could then be considered as an appendix to the
"user manual".
As far as the grammar is concerned, English is my second language, but
that is no excuse when writing a manual.
I do however have dictionaries, and a thesaurus on my desk to help a bit
:)
The "cheat sheets", and stickers now seem like SUCH a good idea, it is
strange to me why we have not thought of it earlier, as the procedures,
and processes to follow could be easily outlined there
e.g. follow these steps to add an account, edit, delete, print etc.
Again, thanks for your input. To a new technical writer (I don't think
I quite deserve the title yet) comments from you are invaluable.
ROBOHELP X5 - SEE THE ALL NEW ROBOHELP X5 IN ACTION!
RoboHelp X5 is a giant leap forward in Help authoring technology, featuring all new Word 2003 support, Content Management, Multi-Author support, PDF and XML support and much more! View an online demo: http://www.macromedia.com/go/techwrldemo
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit http://www.techwr-l.com/techwhirl/ for more resources and info.