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.
> 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 http://fifaworldcup.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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 http://www.ehelp.com/techwr-l
---
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 http://www.raycomm.com/techwhirl/ for more resources and info.
