Re: Figures/graphics in user manuals

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
Subject: Re: Figures/graphics in user manuals

Once again, an issue that depends on the audience level. My
(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
boxes that used generic Windows format, such as file open, save, or

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
to do. Our wizards have a panel on the left that tells the user
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
through a step that could also be done without the wizard. I
the non-wizard step in the user guide, and document the wizard in
wizard. The documentation might say for example: "To generate a
enter appropriate syntax in the Query field," (followed by detailed
instructions on creating a CCM query) "or use the Query Wizard to
you formulate an accurate query."

I always include tool button graphics because they're a nice visual
It tells them specifically what to do rather than just providing a
point for reassurance.
Sella Rush
mailto:sellar -at- apptechsys -dot- com
Applied Technical Systems, Inc. (ATS)
Bremerton, Washington USA
Developers of the CCM Database

Send commands to listserv -at- listserv -dot- okstate -dot- edu (e.g., SIGNOFF
Find TECHWR-L-related books at

Previous by Author: Using GIFs for paper doc's? (Possibly OT and Long)
Next by Author: Re: Converting Frame 5.5 doc to Word
Previous by Thread: Re: Figures/graphics in user manuals
Next by Thread: Re: Frame Printing Help

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

Sponsored Ads