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: Designing a new help system -- Oh boy! ...ugh From:"Kathi Jan Knill" <Kathi -dot- Knill -at- template -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 2 Dec 1999 10:24:43 -0500
Renee asked for help with these issues:
1. Screen shots, good or evil --
I think they are evil! If the user is accessing help, he is already at the
screen he needs to know about. It can be more confusing if even one
tiny detail is changed between what he sees and what is in the screen shot.
I feel very strongly about this ... it is a pet peeve.
2. Internationalization --
Watch the spacing and sizing of menus. If you have a menu bar with 8
selections, words in English may be small but in Japanese may be much
3. Reviews --
Sorry, can't help you there. Never having used JH. However, if you have a\
QA dept., that is one way to make sure that your help does.
(help, I mean ;>) )
4. Project Schedule --
It may be difficult but you have to start with whereever the developers are
at the point in time that you are ready to begin planning. You should know
the features and functions of the system at that point. So you estimate how
long it will take you to do that part. Then you just add in
time factors for how many other features or functions the finished system
will have. (Hopefully someone has specs or at least knows what the finished
product is supposed to be.)
Hope some of this helps.
Kathi Jan Knill
Sr. Technical Writer
Kathi -dot- Knill -at- Template -dot- com
"Learn from the mistakes of others. You can't
live long enough to make them all yourself.""