Chapter summaries at start of doc: yes/no?

Subject: Chapter summaries at start of doc: yes/no?
From: "Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 24 Oct 2006 15:31:36 +0100

In the last couple of companies I've worked for, the documentation
template called for a summary, at the start of the document, of what was
in each chapter. I'm contemplating getting rid of these, for the
following reasons:

1. The Table of Contents should be sufficient to tell you what's in a
chapter. If it's not succeeding, you need to reconsider your headings.

2. Ditto the index.

3. Nobody ever remembers to update the summary.

However, if my logic were really that overwhelmingly obvious and
correct, nobody would be using start-of-document summaries. So... what
am I missing?

Sarah Bouchier
Technical Author



WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at

You are currently subscribed to TECHWR-L as archive -at- infoinfocus -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: So just do it already
Next by Author: RE: Chapter summaries at start of doc: yes/no?
Previous by Thread: RE: FrameMaker mis-using paragraph fonts
Next by Thread: Re: Chapter summaries at start of doc: yes/no?

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

Sponsored Ads