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.
Apparently I didn't know that I was actually a project manager since I'm now
leading the charge in rebuilding our document repository (Sharepoint).
Chapter 37: Indiana Jones and the Artifact Typed
The PMO asked me to come up with a document naming convention. I did. And
I'll give you a little background information first:
- Our organization has a high turnover rate, mostly due to the contractors
we hire.
- We're going to use all of Sharepoint's features, including the versioning.
- I've previously given the PMO a core set of documents that will most
likely be used for all future projects (requirements, use cases, test plan,
etc.).
The naming convention that I came up with is as follows. I really want to
know what others are using:
DEV-PROr1-TheTitleOfTheDocument-BUC
The first part of the naming convention is the name of the department that
the document applies to (DEV=Development, BUS=Business Integration, etc.).
This has met the most resistance, but my justification is that a) people
come and go, but departments are static.
The second part is the name of the project with release number
(PROJECTrelease 1, etc.). We only have one major project at the moment.
The third is the full name of the document (the name of the document is
often vastly different from the type of document).
The last part is the type of document (BUC=Business Use Case, FRQ=Functional
Requirements, etc.).
The quick and dirty is this. If I were a new hire and was told to look on
the Sharepoint site for Engineering's technical specifications, narrowing
the search results down to Engineering's would be a good search criteria to
start with.
Once I wrote the naming convention, I also wrote the document
creation/document change process. This met with some resistance because a
few people want to call these "Artifact Creation" and "Artifact Change"
processes. Artifacts?
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-