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:RE: Terminology for web page elements From:"Partridge, Robert" <Robert -dot- Partridge -at- au -dot- unisys -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Mon, 21 Aug 2006 10:52:05 +1000
Isn't this case a prime candidate for an interface redesign? I've
documented GUIs where the only way to describe the elements was to
specify where in the screen the element was. No logical groups, just
random spatter of widgets. The answer was to go back to the developer
with a more logical, task focused design for the interface where
associated elements were grouped together. The docs and the interface
benefitted, and the users found things so much easier to do.
So is there any way of recommended changes to the web interface? Suggest
using some boxes or shading to associate elements together? Then instead
of talking about the thing in the top left corner, you can say things
like:
In the Sender fields, type the Name, Address and Contact Number of the
client.
Other than that, your only recourse is to document the status quo and
try to point the user to where they might find the field they are
looking for. I don't tend to use screen grabs with callouts for
individual fields unless absolutely necessary as they can quickly
clutter a document and cause a user to flick back and forth. Where I've
used them is in the intro paragraphs to a procedure to indicate to the
user where the logical groups of buttons are. Top section with a box
around several fields with callout to indicate Sender fields, middle
section with a box to indicate Receiver fields, etc.
Rob
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today! http://www.webworks.com/techwr-l
Easily create HTML or Microsoft Word content and convert to any popular Help file format or printed documentation. Learn more at http://www.DocToHelp.com/TechwrlList
---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-
