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.
An appendix in table format that lists all the elements may prove more
useful. I work on applications that interact with mainframe applications.
Many of my users are more familiar with green screens than they are with web
interface, so I provide a set of reference tables that define all the
fields, whether they are calculated or just retrieved, and what they map to
in the mainframe code sets. For the users who started in mainframe, it's
invaluable, for the users who started with web apps, they simply ignore it.
Only key fields defined in these tables are indexed, and the index indicates
a definition as a sub-entry. I'm not sure that defining standard GUI
elements would be much of a help to most users, but I do provide an
introductory topic in help files that lists the primary commands available
as buttons, and that topic is indexed. I think doing the same thing for
every screen in application would be horrendous overkill.
Just MTC,
Connie P. Giordano
Senior Technical Writer
Advisor Technology Services
A Fidelity Investments Company
704-330-2069 (w)
704-330-2350 (f)
704-957-8450 (c)
connie -dot- giordano -at- fmr -dot- com
"Pray that there's intelligent life somewhere up in space, 'cause I'm afraid
that we've been cheated here on Earth" - Clint Black "Galaxy Song"
-----Original Message-----
From: rk5jeeper -at- hotmail -dot- com [mailto:rk5jeeper -at- hotmail -dot- com]
Sent: Wednesday, December 17, 2003 6:51 PM
To: TECHWR-L
Subject: Indexing gui elements
Does anyone have any opinions on indexing gui elements. My group is in the
middle of a debate about including each field, button, etc. in our index.
Some claim users use the index to look up fields. Others think it buries the
real information in our user guides. Unfortunately we have not done a survey
to find out. But I am curious to see if others do index field names. Our
documentation architecture has all gui elements in the various forms and
dialog box separated from our process documentation. I can't remember any
software manuals I have ever looked at that include and index entry for
every field. What say you all?
RoboHelp for FrameMaker is a NEW online publishing tool for FrameMaker that
lets you easily single-source content to online Help, intranet, and Web.
The interface is designed for FrameMaker users, so there is little or no
learning curve and no macro language required! Call 800-718-4407 for
competitive pricing or download a trial at: http://www.ehelp.com/techwr-l4
---
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.
