RE: Checking code (was: Software engineer tech. writers? )

Subject: RE: Checking code (was: Software engineer tech. writers? )
From: "Martinek, Carla" <CMartinek -at- zebra -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 4 Sep 2007 07:31:46 -0500

Of course, I think of this prime example just AFTER I hit the send

Case in point:

Years ago I was documenting a program for a mobile radio computer. As I
went through the program, I started noticing that the buttons used for
various functions (think DOS application screens) varied from screen to
screen. For example, Print might be F6 on one screen, but F8 on
another, and so on.

I mapped out the functions of each button on each screen, and found that
there was no rhyme or reason to the button selections -- they'd picked
whatever they wanted or was open when they programmed a particular
module for the application.

Programming standards either not being in place or not being followed
aside, this is an obvious problems for an end-user. How can they ever
become comfortable with a program when you change the function of every
button from screen to screen? I sent my mapping chart along with
suggestions for change and a write-up as to *why* the current layout was
a bad idea from the user's viewpoint to my engineering contact. If I
remember correctly, they did make the suggested changes and make the
button functions more uniform across the various product screens.


This email and any files transmitted with it are confidential, and may also be legally privileged. If you are not the intended recipient, you may not review, use, copy, or distribute this message. If you receive this email in error, please notify the sender immediately by reply email and then delete this email.

Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more.

True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity!

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit

To subscribe, send a blank email to techwr-l-join -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.


RE: Checking code (was: Software engineer tech. writers? ): From: Martinek, Carla

Previous by Author: RE: Checking code (was: Software engineer tech. writers? )
Next by Author: Word problem with mail merge - help!
Previous by Thread: RE: Checking code (was: Software engineer tech. writers? )
Next by Thread: RE: Checking code (was: Software engineer tech. writers? )

What this post helpful? Share it with friends and colleagues:

Sponsored Ads