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.
Mike wrote:
>
> MoS claims that "Table of Contents" is a term that
> should be avoided in documentation, which, I'll have
> to admit, is the first time I've ever heard that.
> I've always been of the assumption that "Table of
> Contents" is standard terminology.
>
> That aside, I'd like some input as to what you think
> constitutes an effective TOC. I generally include
> primary sections and chapters, as well as figures.
> Question is, when do you recognize that your TOC
> includes too many items?
>
> Any input would be appreciated.....
>
> Regards,
> Mike
>
Usually, MoS is reasonably sensible, but I don't get its logic here.
Unless it suggests simply "Contents?"
As for the contents, I like to put tables and figures into separate
lists so that they're easier to find. I also making a habit of
naming them differently from headings and sections. For example, on
my current project, my headings and sections generally start in a
participle (Understanding Widgets, Setting Up Widgets), while my
tables are unnumbered noun phrases (The ls Command) and figures are
numbered noun phrases.
--
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
604.421.7189 bbyfield -at- axionet -dot- com
"But the place that draws me ever when my fancy's running wild
Is a little pub in Oxford called The Eagle and the Child..."
-Diana Paxson, traditional ending for Mythopoeic Conferences
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Develop HTML-based Help with Macromedia Dreamweaver! (STC Discount.)
**NEW DATE/LOCATION!** January 16-17, 2001, New York, NY. http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.
Take XML and Tech Writing courses online! Our instructor-led courses
(4-6 hrs/wk) give you "hands on" experience at your convenience. STC members
get 20% off! http://www.online-learning.com/index.html.
---
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.
