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:Quick Reference Material in User Guide? From:Jim Hager <jhager -at- techrx -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Wed, 18 Sep 2002 16:18:21 -0400
I'm working on a user guide for a complex application for the medical
industry. It involves lots of screens with lots of fields and some complex
tasks for the user.
I'm contemplating adding some quick reference material inside the user
guide. These blocks of material would be like a quick summary of the tasks
that are rather compex. These would interspersed throughout a chapter as
need and would be in adition to the chapter summaries.
Naturally, these would also be in the online help for the application.
Has anybody here used this technique?
If so, can you provide any guidance?
If you have not used this technique, what do you think of this? (Note. I'm
not asking about separate quick reference guides, I'm asking about imbedding
some quick reference material inside the user guide.)
Thanks for your input.
Lead Technical Writer
jhager -at- techrx -dot- com
FrameMaker-to-PDF TimeSavers Assistants let you enhance & automate navigation
in PDF doc sets (chapter tabs, next/prev chapter/pg, bookmarks, popup menus);
create interactive PDF forms, rollover popups; presentations: http://www.microtype.com
Experience RoboHelp X3! This new RoboHelp release combines single sourcing,
print-quality documentation, conditional text and much more, into the most
monumental release of RoboHelp ever! 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.