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: Context-sensitive vs. navigational 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 10:23:56 -0400
A client of mine wants me to develop a context-sensitive help system for an application. This means that when a user is on a particular screen in the application and clicks Help or F1, a help topic for that screen is displayed. But the client is now concerned that if a user needs to navigate to a particular screen in the application, he/she won't know how to do that unless the help system also provides navigational instructions. How do writers handle this? Do you include separate topics for navigation in addition to providing context-sensitive help for each window? I'm afraid this will make the help system somewhat confusing.
Nope. Look at any Help systems for the applications you use. Chances are they are context-sensitive, yet still available via the Help menu in a stand-alone fashion. The only difference between context-sensitive help and stand-alone help is contect sensitivity, and that's it.
In this case, the user can only access the help file/topics from within the application. There is no way to just open the help and read it without being in the app.
There is no reason why this needs to be the case. No additional work needs to happen to make a stand-alone help system context-sensitive other than adding the topic IDs, and with CHM, even that doesn't need to happen (you can reference the indivitual html topics within a chm from an application easily enough: file.chm#topic.html).
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.