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: Navigational paradigms in very large hypertexts?
Subject:Re: Navigational paradigms in very large hypertexts? From:"David M. Brown" <dmbrown -at- BROWN-INC -dot- COM> Date:Fri, 7 May 1999 14:46:47 -0700
Howard Peirce wrote:
> Our current documentation (shipped in HTML) uses a "library of books"
> navigational paradigm. At the front end, the user chooses one of roughly
> 40 "books," and navigates primarily by means of a java-based
> hierarchical TOC. All the "books" are identically formatted, and
> consistency of look and feel is considered very important.
I think you can vary presentation in precisely the way you described, and still stay with a hierarchical arrangement of your information. You maintain consistency by treating similar elements--procedures, overview, and so on--similarly across the entire work. You could add another layer of variety and consistency by applying sightly different visual treatments to different product segments, for example.
Consistent terminology is probably more important than a consistent "look."
Some other things that will help your readers keep their sense of place in your new document system:
* A self-updating TOC that always shows "you are here"
* A well-formed, comprehensive index--perhaps even multiple indexes
(by product segment, topic type, or both) under a master index
* Related topics lists
* Browse sequences (used judiciously)
David M. Brown - Brown Inc.
dmbrown -at- brown-inc -dot- com