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.
This problem has come about because people use quotation marks around
things that are not the spoken word. While I realize that the convention
started because of the typewriter where there was no way to differentiate
special terminology, there is no reason to continue it when it is now
easy to put special terminology in italics or bold or both. I have also
seen terminology such as that used here put in pointy brackets --
otherwise known as less than and more than signs if it were a
As an editor, I would put it in italics or set up a numbered or bulleted
list as has been suggested by Paul Peterson.
Happiness, joy & laughter
Jacque - Graphic Designer / Writer / Typesetter - Excellence by Design
Pen & Ink Renderings of homes & Bldgs., portraits (people & pets) from
Brochures, Ads, Flyers, Packaging, Business Forms, Manuscripts,
email: foremangraphics -at- juno -dot- com & @earthlink.net, SendOutCards
Rendering & Logo Samples: http://www.foremangraphics.com
On Wed, 12 Dec 2007 11:02:40 -0700 "Paul Pehrson" <paulpehrson -at- gmail -dot- com>
> I suppose it depends on your audience. If you put the comma inside
> quote, a non-technical user might thing you are instructing them to
> type the
> comma as well. In that case, a better option might be to split it up
> 1. When the Test Path screen appears, enter the following:
> C:\Applications\test programs\TS3.exe
> 2. Click Next.
> An advanced user probably won't make the same mistake, so you can
> just put
> in your text in something like:
> On the Test Path screen type C:\Applications\test programs\TS3.exe
> and click
> (If your e-mail program doesn't show the HTML, the path is in a
> Good luck,
> -Paul Pehrson
Create HTML or Microsoft Word content and convert to Help file formats or
printed documentation. Features include support for Windows Vista & 2007
Microsoft Office, team authoring, plus more. http://www.DocToHelp.com/TechwrlList
True single source, conditional content, PDF export, modular help.
Help & Manual is the most powerful authoring tool for technical
documentation. Boost your productivity! http://www.helpandmanual.com
You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-