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.
RE: documenting GUI components that are not labelled
Subject:RE: documenting GUI components that are not labelled From:"Dana Worley" <dana -at- campbellsci -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Fri, 14 Dec 2001 09:11:19 -0700
> There are no icons, buttons are labelled, but that's it. You
> could sort of consider listboxes to be labelled, by virtue of the
> fact that the first item in the listbox is selected automatically.
> There are no tooltips, no popups, b/c it's a non-pointer based
> environment.
If the "non-pointer based environment" does not also include the
help file, then I would create a screen shot with hot spots for all the
fields and buttons. In the text I would tell the user to "select a
component on the graphic below for additional information on that
component" or something like that...
The only pain with this is if the GUI changes frequently, then you
have to redo the screen shots. Of course, if the developers have
been laid off, maybe it's stable :)
Dana W.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.