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:Symbols for system answers. From:"Espling, Ylva" <YLESP -at- WMDATA -dot- COM> Date:Fri, 5 Mar 1999 08:57:35 +0100
I'm writing a "getting started" manual for a configuration management tool.
I use many snapshots, some showing the result of an action and some guiding
the user in the next action. Now me and my colleages have a discussion about
the symbols to use in the manual. We have a "Note!" balloon symbol for
important information, An "Info" symbol for interesting, but not so
important information, and a lightbulb symbol for tips on how to work
quicker and easier.
The thing we are discussing is about having a symbol before system answers
and this is where our opinions differs. Mostly the system answers consist of
a short description and a snapshot of a window. For example:
"The Xtools main window appears" and then a snapshot of the window.
Are you using symbols for system answers? What symbols? If you are not using
symbols, how do you logically and grapchically seperate the information
about the action to be done by the user, and the system answer? Any comments
and suggestions are welcome!