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.
Subject:Re: Typographical conventions From:Janice Gelb <janice -dot- gelb -at- sun -dot- com> To:techwr-l -at- lists -dot- techwr-l -dot- com Date:Tue, 13 Mar 2007 12:17:34 +1100
Harry Bacheler wrote:
> 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.
>
Seems to me that the answer to this problem is to
put the procedural information in numbered steps,
not to litter the paragraph with bold. I think
the bold would still contribute to difficulty
in deciphering the instructional information.
-- 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 archive -at- web -dot- techwr-l -dot- com -dot-