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:Document control procedures From:William Russell <wrpr -at- ZETA -dot- ORG -dot- AU> Date:Sun, 4 Feb 1996 20:27:29 +1100
Hello all,
This is a request for advice on designing and implementing a set of
document control procedures in a software development environment.
The organisation is divided into four project teams developing
software, a test team, and a half-dozen individuals with responsibilities
for areas that cross project boundaries such as security, business analysis,
and documentation (thats me).
All of these people produce documents of one sort or another. We
therefore have an abundance of memos, functional specifications, letters to
clients, communications protocol definitions, user manuals, test plans,
design documents and reports. Unfortunately these documents are
inconsistently scattered across a variety of arbitrary directories, exist in
multiple versions and copies, and are generally in a state of chaos and
confusion.
My first assignment with the company is to rectify this situation.
Since my experience has been in writing end-user manuals, organising only my
own output, I am now seeking advice from fellow technical writers.
Specifically, I would like to know if there are any standards or
common practices relating to:
- directory structures
- templates
- access restrictions on files
- version control rules
- document review procedures
- document release procedures
