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.
John Balchunas is revising <<... operator manuals for a product which has a
touch-screen interface. The original author of the manual inserted
Microsoft Drawing Objects into the text when referring to a touch screen
button [basically shaded text boxes around the touchable icons] ... this
takes up a lot of wasted space (if you add up the extra space above required
for each button over the course of an entire manual it probably increases
the overall page count by 25-30%).>>
I'm a strong advocate of the "show users what something really looks like on
screen" approach, since that requires less mental effort than trying to
figure out "click the icon that looks like an octopus or maybe a squashed
bug". But that's a more important goal for icons than for interface objects
that are exclusively textual. After all, we rarely provide screenshots of a
menu when writing "Open the A menu and choose B" works just fine for most
situations. That being the case:
<<Any thoughts as to how to refer to/indicate touch-screen buttons. I have
considered something as simple as placing the button text in
bold/small-capped font with brackets around it. Something along the lines
of... "7. Touch [Probe Priming Menu]. The following window appears.">>
Works for me, though it may be a pain to have to constantly apply a
different format to all those buttons; if you can define this in a style,
you'd save tons of time. If you're at all worried that some users of the
software won't be able to correlate this semi-graphical representation with
the actual screens, then I'd suggest including a page or two at the
beginning that presents your [Button name] shorthand in some logical order
(e.g., alphabetical, hierarchical by task), followed by a screenshot of the
on-screen display to show what it really looks like.
--Geoff Hart, FERIC, Pointe-Claire, Quebec
geoff-h -at- mtl -dot- feric -dot- ca
"User's advocate" online monthly at
"The most likely way for the world to be destroyed, most experts agree, is
by accident. That's where we come in; we're computer professionals. We cause
accidents."-- Nathaniel Borenstein
IPCC 01, the IEEE International Professional Communication Conference,
October 24-27, 2001 at historic La Fonda in Santa Fe, New Mexico, USA.
CALL FOR PAPERS OPEN UNTIL MARCH 15. http://ieeepcs.org/2001/
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.