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.
when you update a set of user guides ( we have around 20 user guides),
do you have a convention for naming the PDF files.
i.e. if you are writing the ToasterOvenUserGuide.pdf, do you keep the
same pdf name even when it applies to a new software version, or do
you change it to ToasterOvenUserGuidev2_20?
The pros and cons are as follows: The Software dept create a CD of the
user guides, and they are also integrated into the application. The
person doing this does not want me to change the names of the PDF
files each software release as it makes a lot of work for him (of
course at the last minute and under pressure).
On the other hand, if the PDF names are the same, users, and sales and
support staff will not know which version of the user guides they are
looking at (before they open the file), and they may overwrite
previous versions of the user guides which they stilll want (assuming
that not everyone upgrades to each new software version and old files
may still be required)
What do other people do?
Is there some sort of version control for PDF file names.
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-