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.
Subject:RE: PDF filenames - include release designation ? From:Rebecca Officer <Rebecca -dot- Officer -at- alliedtelesis -dot- co -dot- nz> To:Ryan Young <ryangyoung -at- gmail -dot- com>, Margaret Cekis <margaret -dot- cekis -at- comcast -dot- net> Date:Thu, 29 Oct 2015 01:17:04 +0000
We put the SW version in the doc title, the footer and the filename. And we put the document number in the footer. And we put the document revision letter in the filename (rev B etc). And we list the hardware products in the filename and doc title. Our filenames and doc titles aren't short but they are unambiguous!
Cheers
Rebecca
-----Original Message-----
From: techwr-l-bounces+rebecca -dot- officer=alliedtelesis -dot- co -dot- nz -at- lists -dot- techwr-l -dot- com [mailto:techwr-l-bounces+rebecca -dot- officer=alliedtelesis -dot- co -dot- nz -at- lists -dot- techwr-l -dot- com] On Behalf Of Ryan Young
Sent: Thursday, 29 October 2015 2:08 p.m.
To: Margaret Cekis
Cc: TechWR-L
Subject: Re: PDF filenames - include release designation ?
On Wed, Oct 28, 2015 at 5:50 PM, Margaret Cekis <margaret -dot- cekis -at- comcast -dot- net>
wrote:
> Monique:
>
> One company where I worked that included documentation in the
> product's Bill of materials used a 32-character code on every document
> that incorporated the product, the software version, the document
> version, and the release date. It wasn't part of the file name, but
> everything was cross-referenced to it, and that number appeared on the
> title page, and the footers of the rest of the document.
This made me remember that we briefly had a process that added the git commit hash to the title page of PDFs (ie, 3726554c...). You could append that to the filenames to track exactly what changes are in each document.
(But that might be what you meant by "doc revision designation.") ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
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
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
