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:"Sarah Bouchier" <Sarah -dot- Bouchier -at- exony -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Tue, 24 Oct 2006 16:28:05 +0100
>2. Don't know how the index tells me what's in a chapter.
If where to find something isn't obvious from the ToC, I generally skip
straight to the index. Anything that I have to actually +read+ gets
pretty much ignored. I wasn't aware whether other people acted the same
way.
>3. If the summary isn't being updated, update it to reflect the changes
> that got made to the rest of the chapter rather than ditching the
summary.
Obviously when I +notice+ that the summary hasn't been updated, I do.
I've found, however, especially when working with others, that
forgetting to update the summary to reflect changes made is a fruitful
source of errors.
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-