Re: Chapter summaries at start of doc: yes/no?

[Joe Malin <jmalin -at- jmalin -dot- com>]

I usually put in a small TOC at the beginning of each chapter. Even if
the reader looks at the TOC, he or she may not be certain that the
chapter is the correct selection; a summary helps out. I err on the side
of repeating information.

I also do this because it improves single-sourcing organization. I was
trained to put each chapter into one HTML page; having a summary at the
top of the page makes it easier to navigate within the page.

Joe

Sarah Bouchier wrote:
> 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 
>
> exony 
>
>  
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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! http://www.webworks.com/techwr-l
>
> Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
>
> ---
> You are currently subscribed to TECHWR-L as jmalin -at- jmalin -dot- com -dot- 
>
> To unsubscribe send a blank email to 
> techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
> or visit http://lists.techwr-l.com/mailman/options/techwr-l/jmalin%40jmalin.com
>
>
> 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
> http://www.techwr-l.com/techwhirl/ for more resources and info.
>
>
>
>   
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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! http://www.webworks.com/techwr-l

Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.