RE: Poll: How do you differentiate commands, etc. in text?

Subject: RE: Poll: How do you differentiate commands, etc. in text?
From: "Joe Malin" <jmalin -at- tuvox -dot- com>
To: "Diana Ost" <Diana -dot- Ost -at- msmcorp -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Wed, 28 Jun 2006 15:19:21 -0700

For both online and "print" use, I use the following:

bold+default font = GUI term
sans-serif1 bold = terms in our own programming language
monospace = variable names, procedure names, program names
monospace+bold = stuff I expect the user to enter at a command prompt or
shell prompt
sans-serif2 bold = terms defined in the glossary
italics+monospace = replaceable parameters (things that would depend on
the reader's own environment)

To signify a menu selection I use the ">" symbol (ie File > Save)

I do *not* make dialog or message box titles bold, that's just a
stylistic choice I adopted from a previous job. It reduces the amount of
bold.

I always write GUI terms exactly as they appear, including
capitalization. I use Microsoft's standards for referring to GUI
objects. I do *not* put the ellipsis in at the end of a menu command
that opens further options.

Joe


Joe Malin
Technical Writer
(408)625-1623
jmalin -at- tuvox -dot- com
www.tuvox.com
The views expressed in this document are those of the sender, and do not
necessarily reflect those of TuVox, Inc.

-----Original Message-----
From: techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+jmalin=tuvox -dot- com -at- lists -dot- techwr-l -dot- com] On Behalf
Of Diana Ost
Sent: Wednesday, June 28, 2006 11:16 AM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Poll: How do you differentiate commands, etc. in text?

Hi Techwr-l'ers:

In my current situation, we are using InfoMapping for all documentation,
which I am in the process of working over for online use. I am removing
the underlines and quotes around terms, key names, window names,
commands, etc., for a couple of reasons: it's just too much visual noise
in the documents, and because using font changes is probably more
effective than the old-fashioned typewriter style text. (See other
recent topic about The PC is Not a Typerwriter).

I have seen many different ways to handle this (from different fonts
like bold and italic, to icons embedded in the paragraph, to nothing at
all.). I prefer to keep things simple, but still want to make some terms
stand out (and am somewhat opposed to italics for online use--too hard
to read). We also do a lot of policies and procedures, so instructions
are for more than just software use.

What do each of you do (if anything) to emphasis text for online use?
So far, I am doing something like this for procedures:

1. Click this (bold) and the Blah (bold) window appears.
2. Select the Name (bold) field and type your name.
3. Click OK (bold) to save the name and close the window.

I am open to suggestions, and have already found so much good advice
here for other stuff. I look forward to getting Techwr-l'ers experience!


Diana Ost
Technical Writer/Reporting Analyst
Production Administration
Market Street Mortgage Corporation
diana -dot- ost -at- msmcorp -dot- com
Phone (727) 431-7209
Fax (727) 724-9096
2650 McCormick Drive, Suite 200
Clearwater, Florida 33759





This message and any attachments may contain confidential or privileged
information and are only for the intended recipient of this message. If
you are not the intended recipient, please notify the sender by return
email or phone, and delete or destroy this and all copies of this
message and all attachments. Any unauthorized disclosure, use,
distribution, or reproduction of this message or any attachments is
prohibited and may be unlawful.




^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that
easy. Watch the demo at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as jmalin -at- tuvox -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit
http://lists.techwr-l.com/mailman/options/techwr-l/jmalin%40tuvox.com


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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WebWorks ePublisher Pro for Word features support for every major Help
format plus PDF, HTML and more. Flexible, precise, and efficient content
delivery. Try it today!. http://www.webworks.com/techwr-l

Doc-To-Help includes a one-click RoboHelp project converter. It's that easy. Watch the demo at http://www.DocToHelp.com/TechwrlList

---
You are currently subscribed to TECHWR-L as archive -at- infoinfocus -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-unsubscribe -at- lists -dot- techwr-l -dot- com
or visit http://lists.techwr-l.com/mailman/options/techwr-l/archive%40infoinfocus.com


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

Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.


Previous by Author: RE: What do you write?
Next by Author: RE: Bad Bosses Articles
Previous by Thread: Re: Poll: How do you differentiate commands, etc. in text?
Next by Thread: What do you write?


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


Sponsored Ads