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: The Light of Day From:Rowena Hart <rhart -at- xcert -dot- com> To:techwr-l -at- lists -dot- raycomm -dot- com Date:Wed, 26 Apr 2000 13:18:50 -0700
Dianne's posting reminded me of problems
caused by the use/misuse of the following:
- "hidden" HTML comments
- revision control logs
- bug tracking logs
I'm guilty of putting "reminder to self"
HTML comments in documents that are later
released to customers. Although it can be
useful to include comments in your HTML
code, it can be misused.
I've also heard about and seen several
instances of poorly worded revision control
and bug tracking logs (e.g. "Fixed item that
would have worked if so-and-so did their
job properly") that the author probably didn't
realize would be read by testers, developers,
project managers, and sometimes customers.
Revision control logs and bug tracking logs
are usually part of the company's permanent
development record/history.
Rowena
Dianne Blake wrote:
> I recently worked at a place where one of the instructors constantly
> added notes to himself in his PowerPoint presentations. That isn't too
> bad, but he wouldn't go back and look at his work before sending it off
> to the printers, or delivering the materials to other instructors to
> teach.
>
> I can't tell you how many times I would review his work (before teaching
> it, but after he sent it to the printer) and find phrases like:
>
> * Yadda, yadda, yadda
> * Ask so-and-so about this
> * ????
> * What does this mean?
<snip>