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.
I've just started using VisualSource Safe, and it seems to be decent.
When you say documents on paper and on-line, can I nevertheless assume that all of your docs are in electronic format? If so, you can use something like VisualSource Safe to keep close control over the documents. With it, only one user at a time can check-out any single file, and each revision of each document is saved. Also, when a user is checking a document back in, VSS allows for the recording of change information.
VSS is what the developers here use to track their code, but I don't know how you might use it to coordinate software and documentation except by storing the entire product under the same folder. You could have a Folder for Product X, and in it have subfolders for each release, and each of those subfolders have subfolders for the various parts of the product (including documentation).
Leonard
----------
From: deliosoff
Sent: Friday, December 04, 1998 10:54 AM
To: TECHWR-L; LCPORREL
Subject: Documentation management
I support documentation for a project management system. The system is
currently DOS based, but is in the process of being rewritten for
Windows in VB. Formerly, all documentation was on paper, but now of
course we want to take advantage of on-line documentation.
The programmers are incorporating some help as they program, but very
shortly I will be involved setting up the documentation for this new
system. Yes, I know I should have been involved earlier, but let us
not get into that.
My questions are this:
What tools can one use to locate and co-ordinate the interrelation of
documentation when it is scattered over numerous modules, both on-line
and on paper.
Do databases exist that can be used to coordinate software and
documentation changes?
