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.
Feeman Kevin SC2275 asked:
I haven't seen this topic on the list, so I thought I would through
it
out. What is a common way for emphasis in documentation? <snip>
We use bold in procedures for the following:
* Keys users should press.
* Menu options or buttons users should select.
* Text users should type.
We do this so users can skim the procedure and quickly see what they
need to do.
We use italics for the following:
* Names of manuals or other books.
* First occurrance of special terms that are defined at that place in
the text.
We don't use underlines at all. All of these things are defined in our
in-house style guide, so writers here use them consistently in all of
our manuals. That's the real key - consistency! We also list these
conventions in the front matter of each manual so users understand what
they mean.
*************
Kim Cramer mailto:kcramer -at- ncslink -dot- com
Sr. Information Developer
NCS Education, Mesa AZ
*************
TECHWR-L (Technical Communication) List Information: To send a message
to 2500+ readers, e-mail to TECHWR-L -at- LISTSERV -dot- OKSTATE -dot- EDU -dot- Send commands
to LISTSERV -at- LISTSERV -dot- OKSTATE -dot- EDU (e.g. HELP or SIGNOFF TECHWR-L).
Search the archives at http://www.documentation.com/ or search and
browse the archives at http://listserv.okstate.edu/archives/techwr-l.html
