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.
Andrew F. Swartz <aswartz -at- harlequin -dot- co -dot- uk> wrote:
>I did a small survey of my company's users (mostly police officers) and
>found that over half didn't understand the convention Yvonne DeGraw
>suggests: "Choose File-->Open." However, we explain the convention only in
>the preface, and I suspect not many readers look at prefaces. I look
>forward to trying Yvonne's suggestion of explaining the convention on first
>use of each chapter. Since this is one of the most common sorts of
>instructions in a software user manual, it seems like it's worth taking the
>time to figure out the best wording.
Hmmm, police officers ... my dad was a police officer. If you are planning
to test different wordings, I'd test my "novice computer user" style, which
is (with *s around bolded text):
Choose the *File-->Open* menu item.
And on first use in each chapter:
Choose the *File-->Open* menu item. (In this book, *File-->Open* means
you should pull down the *File* menu and choose the *Open* option.)
I'd love to hear the results of any testing you do.
Also, I've had better luck getting people to read a preface when I call it
something like "Welcome!".
Yvonne DeGraw, Technical Services o Technical Writing
yvonne -at- silcom -dot- com o Online Help http://www.silcom.com/~yvonne o Web Documentation
Tel: 805/683-5784 o Database Publishing
Chair, STC Region 8 Conference: http://stc.org/region8/snb/reg8conf
Santa Barbara, CA Call for Presentations deadline is June 30.
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html