Re: software control terms (Returned to the original Topic)

Subject: Re: software control terms (Returned to the original Topic)
From: "Butler, Darren J Ctr 584 CBSS/GBHAC" <Darren -dot- Butler -dot- ctr -at- Robins -dot- af -dot- mil>
To: <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 11 Sep 2007 17:41:27 -0400

>an subjective art (??!!)

Sure, I write for a living.

Like most of us, I often battle with some of my technical customers over
verbs (and don't-get-me-started on adverbs like "gradually") such as
"choose". Since most of these folks aren't the target audience for my
documents, they usually lose the debate. How they want me to say
something isn't always the way my readers will understand it.

(Back to the Original Topic).

I'm curious to hear from technical authors who use rendering conventions
to differentiate between on-screen items (e.g. buttons, check-boxes and
screen titles), function keys (e.g. Enter, F3 and spacebar), and entries
that are to be typed. My office has settled on a convention that seems
to work for our software customers but I'd like to know how others are
writing software documents.

Are you using visual markers such as boxed words or bolded words; or
are you using consistent terms such as:

Term 1 - Always a keyboard function

Term 2 - Always a screen function

Term 3 - When either function may be used

Term 4 - Always typed entries




Darren J. Butler

Sr. Technical Writer-Editor, Template Wrangler, Mil-Spec Pharisee

Integrated Data for Maintenance

NG Corp


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.

Previous by Author: Recall: software control terms (back to the original Topic)
Next by Author: RE: software control terms (back to the original Topic)
Previous by Thread: Recall: software control terms (back to the original Topic)
Next by Thread: Using different versions of FrameMaker in the same team

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

Sponsored Ads