reference info in help

Subject: reference info in help
From: wswallow -at- nycap -dot- rr -dot- com
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Thu, 24 Jun 2004 09:40:54 -0400

> Is there any authority who claims reference information cannot be
> properly placed in online help?

Yes, but their "authority" is only limited to their scope of understanding of the technology, audience, and purpose.

> In fact, our design wound up making the help system into *the*
> reference docs - we had instructions to drop the printed ref
> manual, so
> we figured the ref info could go in Help.

Right. You give people whatever info they need in order to get the job done. There is no formula for this, other than knowing you raudience and what they'll need to get their jobs done. Anyone who tells you otherwise is not adequately assessing thhe situation.

> I entered my reference-based help system in an STC competition.
> The
> judges panned it categorically. "Where's the procedural
> information?"
> they all said. So you can ignore all of the above.

No, you can ignore the STC.


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!

COMPONENTONE DOC-TO-HELP 7 PROFESSIONAL: From a single set of Word documents, create online Help and printed documentation. New version offers yearly subscription service, Natural Search, Modular TOC Utility, Image Map Editor, Theme Designer, Context String Editor, plus more. .

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 for more resources and info.

Previous by Author: re: upload/download terminology
Next by Author: Re: Context-sensitive vs. navigational help
Previous by Thread: RE: List of variables in FrameMaker
Next by Thread: Trados as a style guide enforcement tool

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

Sponsored Ads