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.
Re: docs on frozen CDs - how to handle updates to docs?
Subject:Re: docs on frozen CDs - how to handle updates to docs? From:"Mike Starr" <mikestarr-techwr-l -at- writestarr -dot- com> To:"techwr-l" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 11 Jul 2007 18:55:43 -0500
It would seem to me in most cases that software changes outpace
documentation changes. If your company insists on using CDs as a
distribution mechanism for the documentation, what do they do with updates
to the software? If the software is automatically updated online, then the
update install program can install the documentation as well.
Mike
--
Mike Starr WriteStarr Information Services
Technical Writer - Online Help Developer - Website developer
Graphic Designer - Desktop Publisher - MS Office Expert
Phone: (262) 694-1028 - Tollfree: (877) 892-1028 - Fax:(262) 697-6334
Email: mike -at- writestarr -dot- com - Web: http://www.writestarr.com
----- Original Message -----
From: "Sam TechWriter" <samtechwriter -at- yahoo -dot- com>
To: "techwr-l" <techwr-l -at- lists -dot- techwr-l -dot- com>
Sent: Wednesday, July 11, 2007 11:53 AM
Subject: docs on frozen CDs - how to handle updates to docs?
> I'm looking for best practices for notifying customers that the documents
> on a CD have been updated, and for providing those updated documents. (The
> CDs we distribute to customers combine software with docs; we are expected
> to use the CDs we built with the original docs.)
>
> Customers can access the latest documents on our website, but right now we
> have the problem of inconsistent document delivery, in which the CD
> contains old copies of the docs. We have never had to update documents
> this extensively and I'm wondering if there are alternatives to publishing
> an "Updated Documentation" CD for distribution with the existing CD. I'm
> also wondering if anyone on the list has used this approach and found
> problems...it occurs to me that the update CD and the original CD might
> get separated at some point and the next user down the road might use the
> original CD with the old docs, unaware of any update. I wonder what other
> scenarios I haven't thought of yet! Or maybe I'm just making up problems
> that don't exist...?
>
> Has anyone on the list dealt with updates to docs on frozen CDs before?
>
> Thanks in advance!
> "Sam TechWriter"
>
>
>
> ____________________________________________________________________________________
> Looking for earth-friendly autos?
> Browse Top Cars by "Green Rating" at Yahoo! Autos' Green Center.
>http://autos.yahoo.com/green_center/
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> 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
> mikestarr-techwr-l -at- writestarr -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/mikestarr-techwr-l%40writestarr.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.
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-