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:mlist -at- safenet-inc -dot- com To:Sarah -dot- Bouchier -at- exony -dot- com, techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 24 Oct 2006 12:07:26 -0400
Sarah Bouchier [mailto:Sarah -dot- Bouchier -at- exony -dot- com] noted:
> >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.
This is analogous to living in a shared student apartment.
The person with the least tolerance for mess ends up
doing all the cleaning, and everybody else gets a free
ride (well, except for a blow-up/whine-session once or
twice a year where everybody agrees to do better, but
"forgets" before the meeting breaks up...)
In this case of group documentation projects, the person
who notices (or, should that be, admits to noticing)
the discrepancies gets stuck with the update/cleanup chores.
Kevin
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
