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: Figures/graphics in user manuals From:Heather Ramamurthy <HeatherR -at- MATRIDIGMUSA -dot- COM> Date:Wed, 15 Apr 1998 16:52:30 -0700
What software do you use to create Wizards with your documentation?
-----Original Message-----
From: Sella Rush [SMTP:SellaR -at- APPTECHSYS -dot- COM]
Sent: Wednesday, April 15, 1998 4:50 PM
To: TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU
Subject: Re: Figures/graphics in user manuals
Once again, an issue that depends on the audience level. My
audience
(experienced users/programmers) would probably prefer to keep a
procedure on one page rather than multiple pages with full graphic
coverage. While I will usually include a screen shot of unfamiliar
dialog boxes (depending on how complex they are), I would never
include
boxes that used generic Windows format, such as file open, save, or
print.
I see no point whatsoever in including screen shots or even outside
documentation of wizards. The whole point of a wizard is to include
documentation as part of the process, telling the user step by step
what
to do. Our wizards have a panel on the left that tells the user
what
each step is and what they're supposed to do. Also, each step is
numbered with a big bright number. Generally, our wizards walk a
user
through a step that could also be done without the wizard. I
document
the non-wizard step in the user guide, and document the wizard in
the
wizard. The documentation might say for example: "To generate a
query,
enter appropriate syntax in the Query field," (followed by detailed
instructions on creating a CCM query) "or use the Query Wizard to
help
you formulate an accurate query."
I always include tool button graphics because they're a nice visual
cue.
It tells them specifically what to do rather than just providing a
touch
point for reassurance.
++++++++++++++++++++++++++++++++++
Sella Rush mailto:sellar -at- apptechsys -dot- com
Applied Technical Systems, Inc. (ATS)
Bremerton, Washington USA
Developers of the CCM Database
