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.
How much to tell users about our wonderful software?
Subject:How much to tell users about our wonderful software? From:Carrie Baker <carriebak -at- gmail -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 25 May 2005 13:48:18 +0200
We want to rewrite/upgrade/redo a messy user user guide.
It is an Installation and Configuration guide for a system.
There is currently a chapter there called "The Desktop" which
describes........the desktop.
The main screen is divided into a number of panes later referred to in
the documentation.
It has a section with a list of all the menus available (and what you
do with them in short)
There is also a specific icon which changes color, when each color
means something else and it is important for the user to know.
My questions are as follows:
1. Should you have a marked up picture of "this is what you can see
and what you do with it?" (there is some quite useful info here)
2. Do you need to tell people, these are the menus we have here and
what you do with them. (and also these are all the icons and what
they do)
3. Should there be a section explaining the colors of this special
icon (this is the only one of the above that does not already exist.
New from Quadralay Corporation: WebWorks ePublisher Pro!
Completely XML-based online publishing. Easily create 14 online formats, including 6 Help systems, in a streamlined project-based workflow. Word version ships in June, FrameMaker version ships in July. Sign up for a live, online demo! http://www.webworks.com/techwr-l
---
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.