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.
Subject:Re: Chapter summaries at start of doc: yes/no? From:"David Loveless" <daveloveless -at- gmail -dot- com> To:"Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com> Date:Tue, 24 Oct 2006 11:37:44 -0600
For what it's worth, I included chapter summaries at the beginning of
my most recent manual. On review, I plan on taking them out at my
earliest convenience.
My reasoning:
1--Audience Analysis shows that the manual is used as a reference book
roughly 99% of the time.
2--If the Index and TOC are solid, users will look there and be
directed straight to the appropriate location in the manual. Analysis
confirms this.
3--If they are going straight to the correct location in the manual,
they are not reading the chapter summary.
4--Text unread is wasted.
I also feel that chapter summaries can be construed as redundant
material, though I do see the usefulness of having chapter summaries
in certain contexts for certain audiences. For example, if I write a
workbook, textbook, or other similar material, I find chapter
summaries to be useful clues for what the reader should look for.
Dave
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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