RE: Document Naming Conventions

[Paul Hanson <phanson -at- Quintrex -dot- com>]

I have End-User Docs and Internal User docs. I use the naming convention "NNNNN_EU.DOC" - for end-user docs and "NNNNN_ID.doc" for internal docs. I convert them all to PDFs and have a HTML page that lists the 'subject' by letter. I would never, ever, make the users of these docs try and figure out what it is named. It is the "Quintrex PC Applications End-User doc" to them - not "QPCA_EU.PDF" even though that is the name. I would also suggest that you assign a doc name to whatever they are writing or, without that, that you have the authority to rename it to what you want after they write it.

I would strongly suggest not making someone interpret your naming convention. If you need some sample HTML code to construct a page, let me know - I can share that.

Paul Hanson
Technical Writer
RoboHelp ACE - http://www.adobe.com/support/forums/team_macromedia/robohelp.html
Quintrex Data Systems http://www.quintrex.com
email: phanson at quintrex.com

-----Original Message-----
From: techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+phanson=quintrex -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf Of Caroline Anne Richardson
Sent: Thursday, November 15, 2007 3:21 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Document Naming Conventions

I need to ensure the following is identified in the document name:

- Department (or sub department) name
- Type of document
- Name of document (purpose or procedure description)
- Date (if this is a date sensitive document, not necessary if version number is used in name)
- Version

I would rather keep things simple and easy, so naming something "How to load driver X.doc" would be preferable to "IT_proc_101-123_v1_D-2.doc".  I want to aslo make it easy for my co-workers to adhere to without having to reference the doc that explains how to name your files each time. Simply put, if they have to do that, they won't name them properly when they upload.

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

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.