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:Re: Reference Data and Online Help From:"Bonnie Granat" <bgranat -at- granatedit -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 23 Jun 2004 06:45:23 -0400
Steven Oppenheimer wrote:
>
> But, getting to my question -- I was so busy, trying to explain to the
> documentation manager why it was essential to include the
> descriptions of
> the technical parameters, it never occurred to me to ask him: Just
> where
> does it say, only procedural material can go into online help, but
> never
> reference material?
>
> So, I failed to ask the manager, but I can ask all of you now: Does
> anyone
> know of some study, or textbook, or something that passes for a
> source of
> authority in the field of technical documentation, which states that
> online
> help should only have procedural material, but not reference
> material? I'd
> sure like to know how that manager might have become so fixated on
> that
> idea. Any leads or hints would be appreciated.
>
The online help design and content have to be tailored to the needs of
the people who will be using the program. There is no "rule" except
that.
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
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. http://www.componentone.com/doctohelp .
---
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.
