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

Subject: RE: Checking code (was: Software engineer tech. writers? )
From: Chris Borokowski <athloi -at- yahoo -dot- com>
To: TECHWR-L <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 4 Sep 2007 07:47:04 -0700 (PDT)

One of the reasons I think technical writers should branch out into
usability is that such things often go unnoticed, and fixing them is a
skill that directly relates to the skillset of communicating with
users. Users need consistency, not "creativity" in randomly naming
buttons, commands, and so on. I see inconsistency quite a bit, and most
of my comments returned to engineers are fixes in that area.

--- "Martinek, Carla" <CMartinek -at- zebra -dot- com> wrote:

> 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.
technical writing | consulting | development

Looking for a deal? Find great prices on flights and hotels with Yahoo! FareChase.

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: Word table question
Next by Author: Re: THANKS! Re: Software engineer tech. writers? Do they exist?
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