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: Online Help: How Concise? From:David Egyes <davidegyes -at- HOTMAIL -dot- COM> Date:Sat, 20 Dec 1997 23:05:49 PST
When confronted with this issue - just not being all that sure about the
computer literacy or compentance level of my audience and how much needs
to be explained to them - I take the following approach.
I suppose your help system has some kind of getting started screen or
overview, or at least some place where you introduce the user to the UI.
Use this opportunity describe common activities in full detail - with
all the points, clicks, tabs, buttons, etc. Describe these activities at
this level of detail ONCE. From here on, describe activities more
tersely, using language that assumes a certain level of competence at
If at certain points in the Help system, you fear the user is going to
get lost and might benefit from more remedial level instructions, you
can always include a link back to the getting started/overview screen,
where the more basic skills are covered.