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:"Cekis, Margaret" <Margaret -at- mediaocean -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 13 Dec 2001 14:13:27 -0500
Susie Pearson [mailto:spearson -at- espial -dot- com] asked about "documenting GUI
components that are not labelled."
"The majority of the components in the GUI I'm documenting are not labelled.
I'm taking screen caps as I go along, but when I explain what a text field,
list, etc. is for, how should I indicate to the user what GUI component I'm
using? Callouts on the screen cap? ... the screen cap can get pretty
busy."
_____________________
Susie:
I'd probably show a full screen shot when you start to discuss the screen,
then show partial views of each section as you discuss the fuctionality of
the various icons or choices, thus making it clear to your readers where you
are on the screen without names.
Margaret Cekis
Margaret -at- meciaocean -dot- com
Atlanta GA
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.