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.
Subject:Do we need separate training guides? From:"Daniel Ng" <kjng -at- gprotechnologies -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 24 Sep 2007 19:08:07 +0800
Hi
We are currently have online help for our software built with robohelp.
Our project deployment engineers, arelooking forward to a printable
training guide. Do we need to develop two different sets of
documentation, one a training guide and another branch of documentation
for online help.
* Online help is written as per standard help documentation for
software. Adding this, Splitting that...etc. (Robohelp)
* The training guides (MSWord) are grouped into different job areas or
positions, since different users use different features of the products,
derives information from the help files, with review questions at the
end.
For the old product line, I developed two different branches, maintained
them separately....redundant work, lots of copy paste change issues...
The older you get, the wiser you get I guess.
Anyway, new product, new lease of life. No legacy yet...
There is only one of me, and a translator, so lean management is the key
now.
Questions:
Would you restructure my help documentation, write it like training
guides? Ie. For Executives...etc For Production ....
Merge development platform all into Robohelp but maintain two different
branches of documentation?
Keep it as is, nothing needs improvin'?
Get Flare?
Love your ideas.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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-