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.
> What are people's thoughts about including a software release number in the PDF filename?
Absolutely. Surprised you haven't done so before, actually.
> But if we indicate the software version in the filename, I'd want to indicate the doc revision too.
Ditto.
> And then where does it stop?!
Right about... there.
> Are there any âstandard best practicesâ?
See above :-)
> you lose the ability to track changes and updates if you change a filename.
Release notes for docs. The penultimate release version can be compared against the previous release, and those changes, along with the filename change, release date and whatever other metadata needs to reflect the new release get shoved into the release version, which then gets published. You get a clean branch to update from then on. I find the need for V3 changes compared to V1 very rare, and nothing that can't be established by seeing 2 change lists: V1 -> V2 and then V2 -> V3, IF required.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com
