Re: Editing Online Help

Subject: Re: Editing Online Help
From: Goober <techcommgoober -at- yahoo -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 26 Jun 2002 20:36:13 -0700 (PDT)

> I am writing a paper on editing online help. I would
> like to get
> information on what special methods, procedures, or
> considerations is
> specific to editing online help (for applications,
> standalone, and webhelp,
> etc.) An example would be checking for links and
> jumps.
> What other issues and considerations should a help
> editor take into
> consideration when comprehensively editing help?
> Also, can anyone suggest
> any books/web sites/ articles relating to this topic
> (editing online help)?

You want to check:

* grammar
* all topics are present
* browse sequences
* it launches as intended from the application
* it runs correctly on all operating systems your
application is supported on
* it installs with the product
* the toc/search/ix works
* context-sensitive topics display correctly and
provide the correct information
* if cross-browser, make sure it works in all browsers
your users have (or at least in all browsers your
company decides to support)

I'm sure there's more but that's what you get in a
minute's time. ;)

Do You Yahoo!?
Yahoo! - Official partner of 2002 FIFA World Cup

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
Save $600: Create great-looking Help files and software demos with
RoboHelp Deluxe. Get RoboHelp and RoboDemo - our new demo software - for one
low price. OR Save $100 on RoboHelp Office in June with our mail-in rebate.
Go to
You are currently subscribed to techwr-l as: archive -at- raycomm -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 for more resources and info.

Previous by Author: RE: STC backstabbing? (Take II)
Next by Author: RE: SLAVE labor? (etc.)
Previous by Thread: Editing Online Help
Next by Thread: RE: Editing Online Help

What this post helpful? Share it with friends and colleagues:

Sponsored Ads