Best practices for online help book landing pages?

Subject: Best practices for online help book landing pages?
From: "Tom Johnson" <tomjohnson1492 -at- gmail -dot- com>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Fri, 3 Oct 2008 12:02:56 -0600

Is there a best practice for what should appear when a user clicks a book in
an online help table of contents? (By book I'm referring to the TOC folder
icon that expands to show multiple topics below it.) I've seen three

- A mini-TOC appears listing the topics under the book.
- A summary topic appears describing the entire book (and the topic isn't
listed as one of the topics in the book).
- Nothing appears at all. You have to double-click the book to see the
topics under it, and then select the topic you want.

I currently do the first -- add a miniTOC for the book's topic. But
yesterday I used a help file, saw the same thing, and thought to myself, why
the repetition of the table of contents?


cell: 801-822-2241

ComponentOne Doc-To-Help gives you everything you need to author and
publish quality Help, Web, and print content. Perfect for technical
authors, developers, and policy writers. Download a FREE trial.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


Previous by Author: Re: Mine, mine....ALL mine!
Next by Author: Survey Results for 10 Technical Writing Stereotypes
Previous by Thread: RE: Font fondling - a practical application
Next by Thread: RE: Best practices for online help book landing pages?

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

Sponsored Ads