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:Paper Manual to Online Help - where to start? From:suzy -dot- davis -at- doi -dot- vic -dot- gov -dot- au To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 25 May 2004 15:49:41 +1000
Hello
The time has finally come when I have had to venture into the online help
arena. A couple of years ago I wrote for a client two user manuals (with
diagrams, screen cuts, formatted text, aka the usual), functional spec,
administration guide and an operations guide. The documents are all
200-600 pages each. I am now back to update them, and have been asked to
put them online (which I don't have much experience with - at all, but
fortunately they are ok with that).
I happened to be working on another contract at the time doing some vba
development where a technical writer had just researched a few of the
online help tools and decided on using RoboHelp for the requirement they
had. I have yet to do a final evaluation, but from what I have seen, it
looks like I can pretty much convert my documentation chapters into online
help chapters with very little extra work.
My client is looking for a solution that won't cost as much (I think), or
is preferably free, and is now sending me chm files (which following a
quick search of google and your archives I now know is a compiled help file
which can be generated in a variety of ways including RoboHelp).
Has anyone got some simple suggestions? I am looking for a simple solution
which will require little rework. The manuals are already in an easy to
read procedural format, and the user's don't need context sensitive help,
just an online reference to the book they have had on their desktop. The
other thing is that it has to be fairly easy to update.
There are approximately 20 users.
Am I saving myself from unnecessary grief by committing to RoboHelp? Or am
I missing out on a tool better suited to the task and which will cost my
client less money?
thanks in advance
Suzy
Suzy Davis
suzy -dot- davis -at- doi -dot- vic -dot- gov -dot- au
Technical Writer/VBA Developer
Create Space Pty Ltd
www.createspace.com.au
**********************************************************************
Any personal or sensitive information contained in this email and
attachments must be handled in accordance with the Victorian Information
Privacy Act 2000, the Health Records Act 2001 or the Privacy Act 1988
(Commonwealth), as applicable.
This email, including all attachments, is confidential. If you are not the
intended recipient, you must not disclose, distribute, copy or use the
information contained in this email or attachments. Any confidentiality or
privilege is not waived or lost because this email has been sent to you in
error. If you have received it in error, please let us know by reply
email, delete it from your system and destroy any copies.
**********************************************************************
SEE THE ALL NEW ROBOHELP X5 IN ACTION: RoboHelp X5 is a giant leap forward
in Help authoring technology, featuring Word 2003 support, Content
Management, Multi-Author support, PDF and XML support and much more! http://www.macromedia.com/go/techwrldemo
>From a single set of Word documents, create online Help and printed
documentation with ComponentOne Doc-To-Help 7 Professional, a new yearly
subscription service offering free updates and upgrades, support, and more. http://www.doctohelp.com
---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.