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.
I do, especially if mentioning a file name in a paragraph. For paths, I
don't use boldface because my standard was to put the path on a separate
line just before the screen capture. It is important to make a file names
and terminology stand out (with boldfacing, italics, underlining, or quotes)
because the user may misinterpret part of the name or term as part of the
sentence.
One example that I can remember went something like this:
>From the Work Management Entry Menu select Status Change for Phase.
Is the name of the menu item "Status Change for Phase" or is the menu item
"Status Change" and you are supposed to somehow select it for a Phase? If
"Status Change for Phase" is boldfaced, the user knows that it is a menu
item.
K. Joyce McDonald
----- Original Message -----
From: "Christopher Clunas" <CClunas -at- JetForm -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Sent: Thursday, August 16, 2001 10:53 AM
Subject: Bold to highlight files and paths?
>
> Hi,
>
> Does anybody use bold to highlight file names and file paths in your
> documentation (whether it be print, PDF, or online)? Why... or why not?
>
> Thanks,
> Christopher
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
*** Deva(tm) Tools for Dreamweaver and Deva(tm) Search ***
Build Contents, Indexes, and Search for Web Sites and Help Systems
Available now at http://www.devahelp.com or info -at- devahelp -dot- com
A landmark hotel, one of America's most beautiful cities, and
three and a half days of immersion in the state of the art:
IPCC 01, Oct. 24-27 in Santa Fe. http://ieeepcs.org/2001/
---
You are currently subscribed to techwr-l as: archive -at- raycomm -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- raycomm -dot- com
Send administrative questions to ejray -at- raycomm -dot- com -dot- Visit http://www.raycomm.com/techwhirl/ for more resources and info.
