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:Paul Hanson <phanson -at- Quintrex -dot- com> To:"techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com> Date:Thu, 6 Dec 2007 13:06:26 -0600
-----Original Message-----
Subject: FWD: How is documentation distributed with your application?
<snip>
____________________________________________
1. Does your company release the documentation with the application or after the application has been completed?
PRH:
It depends. Usually, with the application. This is flexible, though, based upon priorities and what the changes are.
______________________________________
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
PRH:
A
__________________________________________________________
3. Is it reasonable to expect the documentation to be distributed at the same time as the application?
PRH:
It really depends upon your development process. I think it is reasonable to expect the user will not have to 'do' anything extra to obtain the doc but whether that means your users always have an Internet connection and are always receiving updates - that's possible. I can tell you a story about how, at job #1, I walked into my mentor's desk piled high with projects. The doc for an update was done *after* the release was out the door. The User Manual was always a release behind. What happened there was that Dev had to have someone in the Doc dept review their project/software change for doc impact. It didn't go to QA unless we signed off on it. Did we get 100% compliance? Nah. Did we get programmers *working with us* so that we were in the loop? Definitely. <shrug> It worked in that environment and may in yours too.
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-
