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.
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
variations:
- 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?
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. http://www.componentone.com/DocToHelp/
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-