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.
<< At my company, the software bug database is also used to submit
related doc bugs. The submitted information about the bug is mainly
related to the software and, as a result, requires quite a bit of
investigation to find the doc impact--if any. The bug basically states
doc impact, doc deliverable, and related product. Currently, writers
read the software bug and investigate the suggested doc impact. [snip]
We use Bugzilla to track software bugs and enhancement requests,
including doc changes. There's not a specific field on the form to note
whether doc changes will be needed, so for a while, I was having trouble
determining which bugs needed my attention.
Now I ask the developers to copy me on any of their bug reports that
might have an effect on the doc. They don't need to know for sure
whether doc changes will be required, but if they suspect that edits
might be needed, I get copied on the bug report. I scan their bug
updates and look for comments that indicate a need for doc changes. It
doesn't take a lot of time; mostly it was the initial challenge of
getting them to copy me on the bugs.
Since it's their responsibility to notify me of changes, it's in their
best interest to CC me on the bugs. They know that I'll follow-up and
keep an eye on anything that will require my involvement. Depending on
the amount of work involved, I may create a related bug just to track
the doc changes, or I may just make notes in their bug report to
indicate what I've done.
It's not perfect, but it works pretty well. I find that the easier I
make it for them to keep me informed, the better it is for all of us.
This way they don't need to write a separate e-mail or make a phone
call; everything is in the bug report.
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-