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: Which do you think is better... From:"Susan W. Gallagher" <sgallagher -at- STARBASECORP -dot- COM> Date:Wed, 16 Aug 1995 18:06:42 -0700
Dan Martilloti wonders which we prefer...
[snip]
> Convention 1
> Select the Edit Manager Properties... option from the Edit menu.
> --screen capture of the Edit menu with the Edit Manager Properties...
> option---
> This displays the Edit Local Print Service Monitor dialog.
> --screen capture of the Edit Local Print Service Monitor dialog--
> Convention 2
> Select the Edit Manager Properties... option from the Edit menu.
> --screen capture of the Edit menu with the Edit Manager Properties...
> option---
> The Edit Local Print Service Manager dialog is displayed.
> --screen capture of the Edit Local Print Service Monitor dialog--
OK Dan, you asked for it. We're loose! ;-)
Problem 1, both menu selection lines read backwards. Keeping
forward motion in your instructions makes them much easier
to read and follow. So, try it this way...
Select Edit > Edit Manager Properties... from the menu.
Problem 2, too many screenshots. You disrupt the flow of the
instructions for no really good reason. Yes, first time GUI
users may find menu shots comforting, but once they've been
using the software for 5 minutes they'll be screaming "enough
already!" Keep the dialog if you must, but drop the menu shot.
Problem 3, why passive???
The Edit Local print Service Manager dialog opens.
or,
The system displays the Edit Local Print Svc Mgr dlg.
[insert screen shot here]
[go on with your instructions]
Problem 4, I hope this is just an example! If you're menu
item repeats "edit" on the edit menu and if "manager
properties" really brings up a dialog called "Edit Local
Print Service Manager", you need to take a good hard look
at the way your interface communicates. Especially if you're
headed toward internationalization.
I realize that you may not have any say in the matter (or
you may not *think* you have any say in the matter) (or this
may be just a bad example and we can all hit delete now and
be done with things), but if I were you I'd give a go at
getting the excess verbiage trimmed from the interface
before you go much further.
$.02 in the kitty
Sue Gallagher
sgallagher -at- starbasecorp -dot- com
