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.
Finally, my company is getting version control software (possibly SVN).
I'm currently working on the standard operating procedures for
documentation, which includes the naming convention for files.
Previously, because we didn't have any good way of controlling versions
of documents, we included the date and version number as part of the
filename (for example ABC_UserManual_DRAFT_02-03-07_v1-3). Now that
we're going to have a more automated system to keep track of this, I'm
debating dropping the date and/or version from the file name.
The main reason I can see for keeping them is that they allow someone to
know how up-to-date a doc is just by looking at the filename. No
checking of the version control system required. (If we go with
Tortoise SVN, that consideration is pretty well eliminated. You can't
get more obvious than a bright green check mark on the file icon.)
It might also be of use to someone who doesn't have access to the
version control system (say, a customer) but who still receives multiple
documents. This both because they will see the date and version easily
and because older documents won't accidentally be overwritten on a
customer's computer.
The main downside is that it complicates the check-in process. If a
file name changes every time a doc is updated, the file has to be
checked in first, then renamed, rather than simply checked in.
Thoughts? Suggestions?
Kelly Keck
Imagine One Technology & Management
Documentation Specialist
(301) 866-4098, ext. 108
kelly -dot- keck -at- imagine-one -dot- com
**Please note my new e-mail address and update your address book
accordingly.**
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
