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.
Re: User interface elements as a section itself in manuals
Subject:Re: User interface elements as a section itself in manuals From:Jerry Kenney <gmkenney -at- MINDSPRING -dot- COM> Date:Wed, 4 Nov 1998 23:00:32 -0500
Thomas Quine wrote:
> ... knowledge of GUI interface components may be a
> prerequisite to carrying out instructions, and therefore must be
> presented to the user.
> But the ideal is to place the unit of knowledge as close as possible to
> the instruction, even, if possible, embedded into the instruction.
> Otherwise you run the risk of the reader skipping over important
> prerequisite information in their haste to do what it is they have to
> do.
I agree with this, but would take it a step further. For users who may not be
familiar with GUI or GUI standards, a brief illustrated introduction to working
with the interface as a stand-alone chapter in the front of the manual will be
helpful for those coming to the application from a character-based interface or
no previous GUI experience. (Some experienced users might find one or two
"ah-hahs" as well.)
