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.
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.
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-