RE: favorite technical style guide?

Subject: RE: favorite technical style guide?
From: "Rebecca Downey" <rdowney -at- matrox -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- raycomm -dot- com>
Date: Wed, 12 Jun 2002 10:09:38 -0400

Steve Hudson (jokingly) answered:
Yeah - mine :-)

Steve makes a very good point here.

I use the Microsoft's Style Guide for Technical Publications (version 1),
but only for the following conditions:
1. When the product I'm documenting *must* run on windows.
2. When I need to use windows-specific terminology regarding:
a. their interface (windows, panes, screens. Radio-buttons, check boxes,
drop down menus, etc)
b. Their methodology (it's not a warm-boot, it's a restart. It's not a
cold-boot it's a shut down and then turn the computer on again.

Otherwise, it's a nice book - but incomplete.

IMHO a "style guide" should really contain several references. The Chicago
Manual of Style is great, but sometimes I want other examples or situations
than exactly what appears within that weighty tome. And occasionally, I
really disagree with it.

I refer to three books (in this order)
The Chicago Manual of Style
Practical English Usage (Swan, Oxford University Press ISBN 0-19-431197-x)
A Style Guide for the Computer Industry (Read Me First, Sun Technical
Publications. ISBN 0-13-455347-0)

For Words (spelling/use) I use:

For Acronyms (spelling/use) I use:

Hope this helps.
Rebecca Downey Senior Technical Writer
ITG:NBM Matrox Electronic System
1055 St Regis, Dorval, Quebec, H9P 2T4

Check out RoboDemo for tutorials! It makes creating full-motion software
demonstrations and other onscreen support materials easy and intuitive.
Need RoboHelp? Save $100 on RoboHelp Office in May with our mail-in rebate.
Go to

Your monthly sponsorship message here reaches more than
5000 technical writers, providing 2,500,000+ monthly impressions.
Contact Eric (ejray -at- raycomm -dot- com) for details and availability.

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 for more resources and info.


RE: favorite technical style guide?: From: Steve Hudson

Previous by Author: RE: When users want jargon
Next by Author: RE: Project Manager Problems - Need Advice Please
Previous by Thread: RE: favorite technical style guide?
Next by Thread: RE: favorite technical style guide?

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

Sponsored Ads