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:Other Help Metaphors - Long From:Jim Shaeffer <jims -at- spsi -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 9 Aug 2001 15:46:06 -0400
Double-posted to HATT and TECHWR-L in response to a comment about
the importance of the "bookish" elements in Help. (I can't find
the original post.)
Premise: When designing online user assistance, there is no
requirement that it be book-like. The use of the book metaphor
in WinHelp, with its table of contents and index, is an accident
of history. Other metaphors would be just as valid/invalid and
useful/obstructive. Hypothetical examples follow.
A Spread Sheet (or Database) Metaphor
Content is in cells. Additional cells in the same row (record) hold
keywords and metadata. Users can use multiple sorts and sub-sorts to
arrange the help information in any sequence they desire. Users
could have access to some columns to add their own keyword lists,
creating customized sorts and searches for their own purposes.
Variables are a natural part of the interface, making customization
a trivial issue (in part). Users have access to a macro language
that lets them mine and repurpose the help to create new sequences
for custom training and orientation of users or other special
purposes.
A VCR Metaphor
Frames and scenes instead of topics and browse sequences. Don't
agonize over the proper names for an interface element, just show
the user how to interact with it. Fast Forward and Reverse rapidly
to scan for Help that looks like the screen you're puzzling over on
the computer. Random access? There have been random access VCRs and
lots of random access laser disks, CD-ROM videos and DVDs. The Help
Writer would be a Video storyboarder and designer. Images would be
central to the work, not peripheral.
A Filing Cabinet (or Library) Metaphor
The Help System is a container that can hold any type of file or
multimedia. Most of the material in the system was not created by
a Help Author, but by the technical experts and product designers.
The help contains the technical specifications, GUI design
documents, etc. The Help Writer is a librarian who organizes,
indexes and abstracts all this stuff. The librarian also structures
task oriented procedural sequences that link to the deeper
technical background. (Can you say "knowledge management"?
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.