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.
Bonita White <bwhite -at- youcentric -dot- com> wrote:
>I am working on a small document, less than 20 pages (more like 15), and
>I was wondering if I should include a TOC and/or and index. I have
>usually followed the "rule" that everything has a TOC and any doc over
>25 pages has both a TOC and an index; but now there is some question as
>to whether that is the case. Opinions/personal preferences/standards?
>Any/all views would be appreciated.
I wouldn't go by the number of pages if I were you. Instead, step
back from your involvement with the work and ask what users are
going to need. Is the work dense enough that an index will help
users find a topic more quickly? Are your users the kind who
would use an index? Would some other aid (possibly, topic headers
and footers) be more useful to them?
In other words, go by the users' needs, not a generalized rule.
Bruce Byfield, Outlaw Communications
Contributing Editor, Maximum Linux
bbyfield -at- axionet -dot- com | Tel: 604.421.7189
"There's a bully in the alley: he'll do his worst,
There's a bully in the alley: he won't fear your curse,
There's a bully in the alley: get your boot in first,
That's what they tell us."
- Oyster Band, "Bully in the Alley"