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.
I've searched the archives, but can't find anything that directly
relates to what I'm doing. I, along with 2 other writers, are in the
process of developing CBT for software application (Windows).
My question is, what should and should not be included? I've
found reams of information on online help and online documentation,
and guidelines on what they should consist of, but there doesn't
seem to be much out there on CBT.
For example, context-sensitive online help should be brief,
simple, and focus on "how" information. Online information
should be easy to read and when possible, avoid making the
user scroll. Anyone know of any guidelines of this type for
CBT, or do the same principles apply? How much information
is necessary? My instincts say that more is not always better,
we should be concise, and show one, simple way to accomplish
a task. In my opinion, a list of components on a window isn't an
effective CBT, but I'm having trouble getting this point across
to the group. Are there any studies, articles, or "rules" that I
can use to make my point?
Thanks in advance.
Kelly Williamson
kelly -dot- williamson -at- cbis -dot- com
