Version control for technical specifications?

Subject: Version control for technical specifications?
From: Krista Van Laan <KVanlaan -at- verisign -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Tue, 6 Mar 2001 15:26:49 -0800

Does anyone manage versions of technical specifications?
We are kicking around ideas about how to manage changes
to technical specs. There are two opposing teams here --
one thinks that there should be a separate change request
document and a person responsible for merging all changes into the
document at the end of some given period. The problem with
this seems to be that there could be a big time lag between
the change to the code and the time when the actual change is
made in the documentation.

The other side thinks that whoever changes the code should
at the same time change the specification document, checking
out the document, and adding a comment about what change they
made. The comment could go into the version control system
and/or into a summary of changes at the beginning of each doc.
One problem here is that people probably will neglect to put
in their comments.

Research I've done indicates that the second method might be
more common, but I may be overlooking something. I'd appreciate
hearing from people who might have some advice on the best
way to manage this.

Thanks,

Krista

================================================
Krista Van Laan
Documentation Manager
VeriSign, Inc. http://www.verisign.com
1350 Charleston Road Mountain View, CA 94043
tel: (650) 429-5158 fax: (650) 961-7300


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30)
http://www.weisner.com/training/dreamweaver_help.htm or 800-646-9989.

IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/

---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit
http://www.raycomm.com/techwhirl/ for more resources and info.


Previous by Author: Re: Estimating the cost of Benefits
Next by Author: "new" technical writer
Previous by Thread: Re: Writing tools: Quark, FrameMaker and others
Next by Thread: RE: Version control for technical specifications?


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

Sponsored Ads


Sponsored Ads