RE: Unique doc IDs

["Lauren" <lt34 -at- csus -dot- edu>]

Hi Exony,

I've always liked using the date in some form when there wasn't some other
ID available, like a project ID.  The date can get lengthy and needs to
conform to the expected life of the document plus a few years.  So use
four-digit years for documents that will be around in a hundred years.  

I tend to compartmentalize everything and "compartments" that people can
easily accept get used in communication and file naming.  Like "O" for
operations, "S" for system, and "A" for administrative.  The group that the
document supports can also get into the ID.  What the document supports can
also be there, but that is usually unique by itself, unless there are a lot
of documents in the group.  The version number also gets into many document
titles.  

So the first draft of an Administrative document that is created for the
Technical Publications group on August 6, 2007 (or the week beginning that
date) and that supports file naming, may be called
"TP-A-20070806-naming-v0."  

You can also just sequentially number all of your documents with an 8-digit
number.

Lauren
 

> -----Original Message-----
> From: techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com 
> [mailto:techwr-l-bounces+lt34=csus -dot- edu -at- lists -dot- techwr-l -dot- com] On 
> Behalf Of Sarah Bouchier
> Sent: Monday, August 06, 2007 4:13 AM
> To: techwr-l -at- lists -dot- techwr-l -dot- com
> Subject: Unique doc IDs
> 
> What is the best way to ensure that each document has a 
> unique ID?  I'm
> currently looking at introducing a scheme whereby all the documents
> produced by the company (including those written by developers) have a
> unique ID, but I'm having difficulty working out how to ensure
> uniqueness.
> 
>  
> 
> Before I go reinventing the wheel (or a clumsy variant 
> thereof with many
> bumpy corners), what methods do other people use?
> 
> Sarah Bouchier
> Technical Author
> 
> exony
> 
>  
> 
> 
> ______________________________________________________________________
> This email has been scanned by the MessageLabs Email Security System.
> For more information please visit http://www.messagelabs.com/email 
> ______________________________________________________________________
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> 
> 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 lt34 -at- csus -dot- edu -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/lt34%40csus.edu
> 
> 
> 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.

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

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.