RE: Typographical conventions

Subject: RE: Typographical conventions
From: "Harry Bacheler" <hbacheler -at- aol -dot- com>
To: "Janice Gelb" <janice -dot- gelb -at- sun -dot- com>, <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Mon, 12 Mar 2007 19:39:34 -0400

I agree to a certain extent.

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-

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/hbacheler%40aol.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.


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

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 &amp; 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 &amp; Manual: http://www.helpandmanual.com

---
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 http://lists.techwr-l.com/mailman/options/techwr-l/archive%40web.techwr-l.com


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
http://www.techwr-l.com/techwhirl/ for more resources and info.


Follow-Ups:

References:
Re: Typographical conventions: From: Janice Gelb

Previous by Author: Re: A small request...and re: your typographical conventions
Next by Author: RE: Line spacing and tables in Word
Previous by Thread: Re: Typographical conventions
Next by Thread: Re: Typographical conventions


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

Sponsored Ads


Sponsored Ads