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.
Poll: How do you differentiate commands, etc. in text?
Subject:Poll: How do you differentiate commands, etc. in text? From:"Diana Ost" <Diana -dot- Ost -at- msmcorp -dot- com> To:<techwr-l -at- lists -dot- techwr-l -dot- com> Date:Wed, 28 Jun 2006 14:15:54 -0400
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