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'm looking for a formal means of keeping track of document revisions in
our programming department. Most of the 100+ documents are WORD
documents (anywhere from 10 to 120 pages) accessed via an Intranet.
My question: Is there a *definitive* technical writing source that deals
with questions such as:
+ What determines the version number in a document? Changes in the
program or object being documented, or changes (corrections, etc.) in
the document itself?
+ When changes are made to the initial version of a document, does the
document's version number become "Rev. 1.2" or "Rev. 2.0"?
+ Should a date be included in the header info. as well as a version
number?
+ How are users best notified of changes to a document? Via an errata
page, change bars, etc.?
Doug Andrews
doug -dot- andrews -at- gs -dot- com
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
