RE: Document Naming Convention

Subject: RE: Document Naming Convention
From: "Dori Green" <dgreen -at- associatedbrands -dot- com>
To: "Techwr-L List" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 12 Jul 2007 10:31:56 -0400

Ah yes, this discussion again.

Our naming convention:

Letter prefix Unique 3 or 4-digit number Rev extension (type of document)

P = QMS process overview arbitrary & meaningless 0 .doc, .gfx, .jpg, .html, etc.
PS = company-specific PO
IN = work instruction
D = QMS form or supporting doc
DS = company-specific form or...
DEX = external document (reference)

Details about each document are kept in the document control database. We emphatically do not attempt to provide all details within the document name. We do include the Rev level because we require our people to check "uncontrolled" copies against the current master list of controlled documents before using them. If the rev levels match, they're okay.

Example:

P 421 Rev 2.doc = Document Control Process Overview

We are a not-sophisticated manufacturing operation (dry food packaging). Requirement for employment = breathing and GED. Oh, and green card (it's getting into harvest season so this is a big issue around here again this year).

I did play with the idea of keying the number to the category (for instance, all IN 09XX documents would be related to PS 090) -- sanity struck and I gave up on that idea. Each process overview includes a detailed process flow chart and documentation map. Each box on that flow chart includes:

WHO DOES IT
WHAT THEY DO
ASSOCIATED DOCUMENT (more details)

Works well for us, despite some pretty complicated processes. YMMV.

Dori Green


^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/ for more resources and info.


References:
Document Naming Convention: From: James Barrow

Previous by Author: RE: Grammar Question
Next by Author: RE: Ethics of Jumping To Another Contract Job
Previous by Thread: Document Naming Convention
Next by Thread: RE: Grammar Question


What this post helpful? Share it with friends and colleagues:


Sponsored Ads