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.
If your steps are in a 'numbered' list, there might be a reason for not
capitalizing and bolding.
However, if you have a narrative paragraph containing 'many' steps to be
performed, Capitalizing and Bolding the 'key caps', pop-ups, and menu
selections, may help the reader to understand what is actually happening.
(Of course, you have to take into account the reading level of the reader.)
I have seen, and edited a great num ber of procedure docuemtns that were
narrative in nature. When stepping through the paragraph, picking ouut the
steps, it was sometimes difficult 'deciphering' the paragraph and the
embedded 'instruction.
What a bummer that is. Especially if the person writing the paragraph(s)
missed one or two steps, and you had to go to the 'screen' and try the
procedure out. Didn't work out a lot of the time.
Among other documents that I referred to in developing the table I provided
is the QUE Special Edition Using Microsoft Office 2000 Small Business
Edition ((c) 1999), ISBN 0-7897-1969-X, Introduction, Conventions used in
this book, page 5.
Our approach at the Government agency was making the decision that Keycaps
were BOLD and Capitalized.
Harry
-----Original Message-----
From: techwr-l-bounces+hbacheler=aol -dot- com -at- lists -dot- techwr-l -dot- com
[mailto:techwr-l-bounces+hbacheler=aol -dot- com -at- lists -dot- techwr-l -dot- com]On Behalf
Of Janice Gelb
Sent: Monday, March 12, 2007 4:54 PM
To: techwr-l -at- lists -dot- techwr-l -dot- com
Subject: Re: Typographical conventions
Joanne Wittenbrook wrote:
>
> With the easy availablility of font styles, people can get a little font
crazed. I use bold for user actions because it makes it easier for users to
scan their steps for clues as to the next step while working.
>
I've seen this explanation for bold use before,
but frankly, I don't *want* readers to skip
the explanatory text between the key names
they're supposed to press or the menu options
they're supposed to select!
-- Janice
***********************************************************
Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- sun -dot- com | this message is the return address
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team
authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as hbacheler -at- aol -dot- com -dot-
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include single source authoring, team authoring,
Web-based technology, and PDF output. http://www.DocToHelp.com/TechwrlList
Now shipping: Help & Manual 4 with RoboHelp(r) import! New editor,
full Unicode support. Create help files, web-based help and PDF in up
to 106 languages with Help & Manual: http://www.helpandmanual.com
---
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-
