Re: Getting Code Changes Into Documentation

Subject: Re: Getting Code Changes Into Documentation
From: yvonne -at- SMARTSTAR -dot- COM
Date: Mon, 10 Apr 1995 08:59:24 -0700

MacGyver asked:

> How do you find out what software changes affect the documentation?

In addition to methods mentioned by others, I get a mail message about
software changes every day. This happens automatically, because our
programmers use code control software that prompts them for a description
of the change and the problem # in our bug tracking system for the change.
Every night, an automatic procedure gathers all the comments and sends the
list of changes as e-mail to all the programmers. All I had to do was ask
to be added to the mailing list.

Of course, their comments aren't always all that clear. But with practice,
I've learned which types of changes are likely to affect the documentation.

Yvonne DeGraw
yvonne -at- smartstar -dot- com
Sr. Technical Writer
SmartStar Corp.

Previous by Author: A HUMBLING APPROACH
Previous by Thread: Re: Getting Code Changes Into Documentation
Next by Thread: Is Frame a resource hog?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads

Sponsored Ads