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:Iggy <iggy_1996dp -at- yahoo -dot- com> To:"TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com> Date:Thu, 13 Dec 2001 09:58:24 -0800 (PST)
If it's going to be hard to document then it's going
to be hard to understand. Remember, for every bright
and savvy user in the world, there is also a complete
idiot jonesing to call tech support.
So it's just a screen of blank fields and gray
buttons? Please define "not labelled". If it's truly a
blank screen with fields, definitely talk to the GUI
team and have them plop some words or icons in there.
--- Susie Pearson <spearson -at- espial -dot- com> wrote:
> 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 only
> problem there is that the
> screen cap can get pretty busy. Should I perhaps
> talk to the GUI designers
> about labelling screen components? The app I'm
> documenting is a TV-based
> e-mail app, nothing fancy, and I don't think the
> unlabelled GUI components
> will give users grief, it only makes it hard for
> *me* to document.....
__________________________________________________
Do You Yahoo!?
Check out Yahoo! Shopping and Yahoo! Auctions for all of
your unique holiday gifts! Buy at http://shopping.yahoo.com
or bid at http://auctions.yahoo.com
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Be a published author! iUniverse gives you: a high-quality paperback, a
custom cover design, and distribution to 25,00 retailers. And it's
affordable. Join our alomst 10,000 published authors today. http://www.iuniverse.com/media/techwr
Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.
---
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.
