RE: Version control for technical specifications?

Subject: RE: Version control for technical specifications?
From: "LeVie, Donald S" <donald -dot- s -dot- levie -at- intel -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 7 Mar 2001 05:04:14 -0800

re: Spec change requests

We use Documentum for managing version/change control for our specs. Our
specs go through a rigorous document inspection method (which I wrote about
back in November for the TECHWR_L website) that classifies "defects" as
being "High," "Moderate," and "Low." Most of the Low defects relate to
style, grammar use, template irregularities, etc. Once a spec reaches
version 1.0 and is locked in, any changes to the technical content must be
preceded by an engineering change order (ECO). Prior to that version, it's
not necessary.

In a nutshell, it looks like this:
1. First draft edit: all document authors check in files to Documentum for
first draft edit and creation of Frame and PDF book for review
2. Second draft edit: happens AFTER the section(s) have been inspected and
corrections to content have been made by inspection team (usually the
section author and other SMEs plus the tech writer). Each section is checked
in as it is finished for intermediate draft edit. Once all sections have
been inspected, checked in, and edited, books are regenerated.
3. Third-draft edit: Those sections requiring additional changes (based on
latest product design information) undergo a final edit after being checked
in to Documentum. The resulting books are Version 1.0

All sections are then checked out by tech pubs until the books (Frame and
PDF) are verified to be "clean." Any changes to Version 1.0 require ECOs.

The publications team is immune from having to submit ECOs.

Donn Le Vie
Information Engineering
Network Communications Group
Wireless Communications and Computing Group
Intel Corporation

My thoughts and comments, not Intel's.


Develop HTML-Based Help with Macromedia Dreamweaver 4 ($100 STC Discount)
**New Dates!!** San Francisco (Apr 16-17), San Jose (Mar 29-30) 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.

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 for more resources and info.

Previous by Author: RE: New TECHWR-L Poll Question
Next by Author: Looking for Article in a Haystack
Previous by Thread: Version control for technical specifications?
Next by Thread: Can't view/or print text box in footers

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

Sponsored Ads