Re: Chapter Overviews

Subject: Re: Chapter Overviews
From: Peter Neilson <neilson -at- alltel -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Jul 2004 18:34:31 -0400

On Mon, 19 Jul 2004 15:44:11 -0500, Martinek, Carla <CMartinek -at- zebra -dot- com> wrote:

All -

Do you feel that a user guide, in the "About This Book"
(or equivalant) section, should contain a high-level overview
comprised of a list of chapters and a one or two line
description for each? ...

Done well, it ought to seem like a necessary part of the book.
But done according to formula, it'll be unusable. Here's a
sample of the latter, reconstructed from memory from a job
where we were supposed to boilerplate that kind of stuff in. (If
I remember correctly my contribution shot down the boilering.) I
must have written it on a Friday. Must have been Friday. Yeah.

IMPORTANT! This book is divided into chapters. The reader
should read each chapter thoroughly and understand it before
reading the next chapter, because we wrote each chapter with the
reader in mind, and it was a lot of work. The chapters are
divided into paragraphs, and the paragraphs into sentences,
which in turn are composed of words and phrases, all of them
carefully constructed, and subsequently tested for readability.


There was likely much more, but fortunately I didn't save it,
not anywhere.


ROBOHELP X5: Featuring Word 2003 support, Content Management, Multi-Author
support, PDF and XML support and much more!

WEBWORKS FINALDRAFT: New! Document review system for Word and FrameMaker
authors. Automatic browser-based drafts with unlimited reviewers. Full
online discussions -- no Web server needed!
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -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 for more resources and info.

Chapter Overviews: From: Martinek, Carla

Previous by Author: Re: STC Transformation -- (getting off topic a bit)
Next by Author: Re: CD Life
Previous by Thread: Re: Chapter Overviews (Just say No...)
Next by Thread: RE: Chapter Overviews

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

Sponsored Ads