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: How is documentation distributed with your application?
Subject:RE: How is documentation distributed with your application? From:"McLauchlan, Kevin" <Kevin -dot- McLauchlan -at- safenet-inc -dot- com> To:"TECHWR-L Administrator" <admin -at- techwr-l -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 6 Dec 2007 15:13:15 -0500
Anonymous wanted to know:
> 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.
[...]
> 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?
Wow.
I'd lo-o-o-o-ove to have the luxury of preparing and shipping
customer/user documentation _after_ the product is finished. It just
doesn't get much more stable than... "finished".
Our docs are mainly WebHelp these days and go out on the same CD (or tar
file) that contains the software, and is shipped with the hardware. So,
when things are still in flux until halfway through the QA cycle, I
still have to get my docs completed, accurate and functional before QA
approves the last Release Candidate and the whole thing goes into the
ERP system.
Also, I'm struggling to justify posting my Help to our company website.
Maybe I'll open another thread on exactly that topic.
Kevin
The information contained in this electronic mail transmission may be privileged and confidential, and therefore, protected from disclosure. If you have received this communication in error, please notify us immediately by replying to this message and deleting it from your computer without copying or disclosing it.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-
