Re: PDF filenames - include release designation ?

Subject: Re: PDF filenames - include release designation ?
From: "Monique Semp" <monique -dot- semp -at- earthlink -dot- net>
To: "TechWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 12 Nov 2015 15:05:26 -0800

> What are people's thoughts about including a software release number in the PDF filename? ... But if we indicate the software version in the filename, I'd want to indicate the doc revision too. (Sometimes the docs get revised between releases, so two doc sets per a given release number.) And then where does it stop?!

Getting back to this now (too busy writing the docs to worry about *naming* them :-).

So the collective mind has convinced me that it's a good thing to include the software release version in a PDF's filename, and that it makes sense to include the doc revision info, too.

So now my question is, what would be the revision designation for the original release if I go with alphabetic designations for doc revisions: A, B, C... ?

In the past, I've used numeric designations for revisions: 00 for the original release, and 01, 02, etc. for revisions. But I hadn't included that info in the filename, just as a document part number. But my concern with including numeric revision info in the PDF filename is that it could too easily be confused with a release designation.

So for best PDF filename usability, alphabetic designations for doc revisions seem much better. But unless the original release is designated as revision 0 (zero), there wouldn't be any revision info in the filename, but subsequent revisions would include this "field".

* So would people know which doc is the most recent if they see 4.5_prodName1_Users_Guide.PDF and 4.5_prod_Name2_Users_Guide_A.pdf?

* Would they be confused if they saw 4.5_prodName1_Users_Guide_0.pdf and 4.5_prodName1_Users_Guide_A.pdf?

Thoughts and suggestions are welcome!
-Monique
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.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-leave -at- lists -dot- techwr-l -dot- com


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

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


Follow-Ups:

Previous by Author: Re: FrameMaker does NOT update links . . . .
Next by Author: Re: PDF filenames - include release designation ?
Previous by Thread: bounce messages
Next by Thread: RE: PDF filenames - include release designation ?


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

Sponsored Ads


Sponsored Ads