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:Inclusion of Field Descriptions in Help Systems From:David Goldberg <david -dot- goldberg -at- jda -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Tue, 20 Nov 2001 14:15:49 -0700
I would like to know how others handle the definition of fields in
non-context sensitive Help systems for large software applications,
particularly using the RoboHTML and WebHelp products.
Do you put all application field definitions in a common glossary and link
to the glossary from the procedural topics? Do you have separate field
description topics per application screen and list the definitions there?
Do you use techniques like text-only popups to display the field definitions
without having the user leave the procedural topic?
All these techniques have pros and cons. I have yet to identify an optimal
solution. Your feedback is welcome. Thank you.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Collect Royalties, Not Rejection Letters! Tell us your rejection story when you
submit your manuscript to iUniverse Nov. 6 -Dec. 15 and get five free copies of
your book. What are you waiting for? http://www.iuniverse.com/media/techwr
---
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.