Re: Chapter Overviews

Subject: Re: Chapter Overviews
From: Kat Nagel <mlists -at- masterworkconsulting -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Mon, 19 Jul 2004 18:59:34 -0400

At 3:44 PM -0500 2004/07/19, Martinek, Carla wrote:

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?

If the chapter titles are descriptive enough, a section like that isn't needed. If, on the other hand, the chapter titles are cute and clever, you should probably give the users a one-sentence description that tells people what those clever titles are hiding.

Kat Nagel,
who (in case you were wondering) has gotten awfully tired of cleverness that interferes with understanding.


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.

Previous by Author: Re: Time estimate for writing manual
Next by Author: Re: WebWorks vs. RoboHelp
Previous by Thread: Re: Chapter Overviews
Next by Thread: Re: Chapter Overviews

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

Sponsored Ads