Re: Category vs. Alphabetical Listing in Contents Tab in Online Help

Subject: Re: Category vs. Alphabetical Listing in Contents Tab in Online Help
From: Chris <cud -at- telecable -dot- es>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 12 Mar 2003 09:53:04 +0100


I fully agree with David. The categories you provide help the user model the product - if nothing else, the way you view the product model influences the way you write about the product, so explicitly describing that model via TOC categories will at least help users understand *your* organization of the material. To the degree that your organization reflects the organization of the product itself, you will also help the user understand the actual product model.

If your organization of the paper version is categorized, the paper TOC will also be categorized. That's because the TOC follows in page-count order, and so does your organization of the material. Just because you go online, there's no reason to drop this effect from the TOC. Just because you don't have pages, that doesn't mean you suddenly don't have an organizing model. In fact, it's that much more important to represent the model, because the loss of pages means you lose the tactile representation of your organization.

At least that was the theory behind the one help system I designed from the ground up.

Then again, if there's no organizing model to the thing, alphabetical makes sense. For example, a command reference for programming is often best done alphabetically. In that case, the TOC would come out alphabetical in paper - probably should online, too.

Matthew Nankin wrote:


We are in the middle of upgrading our help system and trying to decide the
relative merits of an online contents tab organized by subject vs. that same
contents organized alphabetically.


People will turn to the Index tab for an alphabetical list of concepts. (Of course, it's up to you to make it a valuable resource.)

The Contents tab is your opportunity to show them how *you* see the material organized and structured, whether it's by task, product module, menu hierarchy, or some other criterion. Even a dictionary or encyclopedia will have introductory matter and appendices, so a TOC wouldn't be purely alphabetical.

--David


--
Chris Despopoulos, maker of CudSpan Freeware...
Plugins to Enhance FrameMaker & FrameMaker+SGML
http://www.telecable.es/personales/cud/
cud -at- telecable -dot- es


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Order RoboHelp Office X3 by March 14 and receive a $100 mail-in rebate,
plus FREE WebHelp Merge Module and FREE iMarkup Software, for a
total giveaway value of $439! Order today at http://www.ehelp.com/techwr-l

Help celebrate TECHWR-L's 10th Anniversary starting this month!
Check out the contests at http://www.raycomm.com/techwhirl/special/contests/
Happy birthday to you, happy birthday to you, happy birthday TECHWR-L....

---
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.



Follow-Ups:

Previous by Author: Re: Question-How independent is "independent contractor status?"
Next by Author: Re: Help needed: FM bodypage/masterpage graphic interference
Previous by Thread: Re: Category vs. Alphabetical Listing in Contents Tab in Online Help
Next by Thread: Re: Category vs. Alphabetical Listing in Contents Tab in Online Help


What this post helpful? Share it with friends and colleagues:


Sponsored Ads