atw: Re: Migrating user documentation online
- From: Michael Bouy <michael.bouy@xxxxxxxxxxxxxxxxxxxxxxx>
- To: austechwriter@xxxxxxxxxxxxx
- Date: Tue, 8 Jun 2010 15:29:12 +0930
Another option used by many companies is RoboHelp -
http://www.adobe.com/products/robohelp/
I've used it to convert very large user manuals to fully indexed, searchable
CHM help files. It requires strict adherence to Word stylesheet formats to
build the TOC, as I'm sure most other products would require as well. You
could include hyperlinks to video tutorials that are hosted on your server -
I'm not aware of software that will incorporate videos into the CHM.
Be aware when planning the project that you need to allow a number of days
(depending on the size of each document) to insert index entries in the
document, rigorously check the stylesheets in the document and make it
consistent, import your styles into Robohelp, compile test CHM files and
check the section breaks and headings, fix any stylesheet errors, recompile
and repeat until it is perfect.
Michael
On 8 June 2010 13:46, Anthony Stoner <anthony@xxxxxxxxxxxx> wrote:
> Hi Ngaire,
>
> We use Doc-to-Help to convert multiple Word files to an HTML help package,
> with a range of conditions and variables to produce exactly the output we
> need for different versions of our product. I've found D2H to be very very
> good for handling Word files and producing excellent output with little
> tweaking. I'd stick with D2H, unless you have a requirement which it simply
> does not meet.
>
> cheers,
> Anthony
>
> On 7/06/2010 6:34 PM, Ngaire Eyers wrote:
>
> Hi all
>
> I'm developing an outline of the work required to migrate our documentation
> online. In the past our software User Guides were converted from Word using
> Doc-to-Help to .chm files. Some of our users experience difficulty in
> viewing those files so for this and many other reasons (including
> maintenance obviously), we are migrating the Help online. Currently our User
> Guides are converted from Word to .pdf, and are available to the user
> latterly by selection from a central Help icon dropping to a menu. In some
> packages the user may access up to four separate guides. The two most
> comprehensive modules boast User Guides put together over many years,
> of around 24,800 KB; and 46,500 KB (in Word .docx).
>
> This is a huge task of conversion, not to mention checking the currency of
> all material put online. Does anyone have any relevant experiences, or
> pitfalls, know what would be a good tool/s to use, and where to begin with
> this initiative?
>
> While you're at it, for our online software I'm researching the best means
> of creating short video clip help material for key functionality. Any best
> tips for creating that would also be greatly appreciated!
>
> Look forward to hearing your experiences.
>
> Ngaire
>
>
>
>
> --
>
> *Anthony Stoner
> Release Manager*
>
> *Studywiz Pty Ltd *
> Level 1, 61 Davey St
> Hobart
>
> *www.studywiz.com*
>
>
> ----------------------------------------------------------------------------------------------------------------------------------------------------
> IMPORTANT: This e-mail message and any attachments are confidential and may
> be privileged.
> If received in error, please reply to this message and destroy all copies
> and any attachments.
> You should check this message and any attachments for viruses or defects.
> Our liability is limited
> to resupplying any affected message or attachments. For more information
> about Studywiz,
> please visit us at: http://www.studywiz.com <http://www.etechgroup.com.au>
>
Other related posts:
