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.
FWD: How is documentation distributed with your application?
Subject:FWD: How is documentation distributed with your application? From:TECHWR-L Administrator <admin -at- techwr-l -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Thu, 06 Dec 2007 09:14:06 -0700
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
This message was forwarded anonymously on request. Please
reply on TECHWR-L to ensure that the original poster sees the
response. Responses will not be forwarded to the original poster.
&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&&
My company like to distribute the documentation after the code and
testing has been completed. I have been striving to change this
mentality and get the documentation released with the application.
However, there is a great deal of resistance to this. The application is
released to manufacturing (RTM) and before it goes out to customers, the
documentation is completed. However, there is always a “catch up”
situation going on and the documentation is proof-read but not always
thoroughly tested.
At present some documentation is released with the product and the
remaining documentation is obtained by downloading the documentation
from the company’s website. I think this means that customers do not
always have the up to date versions of the documentation and the
documentation is not always in the folder structure which is required to
use Adobe Catalog.
My questions to you all are as follows:
1. Does your company release the documentation with the
application or after the application has been completed?
2. How do customers obtain documentation ?
a. With the application
b. From the company’s website
c. A combination of a. and b.
d. Other
3. Is it reasonable to expect the documentation to be distributed
at the same time as the application?
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-