Re: Style Guides

Subject: Re: Style Guides
From: Stuart Burnfield <slb -at- westnet -dot- com -dot- au>
To: techwr-l -at- lists -dot- techwr-l -dot- com
Date: Tue, 08 May 2007 12:41:27 +0800

1) The address for IBM Style has changed. You can now get it from here:

http://www.ibm.com/easy/page/1387


2) A hearty "Hear, hear!" to those who recommended the Sun style guide.
It's the one-volume 'desert island survival guide' for tech writers.

3) I believe a corporate style guide should be as short as possible. By
that I mean a 5-page style guide is better than a 100-page style guide.
It should complement existing references, not supersede them. In other
words:
- Give writers access to a single official reference such as the Sun
style guide or MMoS. Tell them to use it in all instances except where
the advice is superseded in your local style guide.
- Nominate a dictionary to be used for all words except those specified
in your local 'special terms' list.
- Define fonts and page layouts in templates.

4) Bear in mind that the benefits of a style guide come overwhelmingly
from consistency, not from the merits of the rules themselves. For all I
know Rahul's preferred way of punctuating lists may be 2% better than
Russel's and 2% worse than Ricky's, but you could pick any one and
you'll be 98% better off just because you're all doing it the same way.

This isn't to say that the rules themselves are unimportant, but it
should help you decide how much time it's worth putting into
researching, rewriting and arguing about local rules. (Hint: not much.)

Stuart
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

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


Follow-Ups:

Previous by Author: RE: Justification for hiring and realistic deadline - pls help.
Next by Author: FYI: FrameMaker 8 beta programme
Previous by Thread: Re: Style Guides
Next by Thread: Acrobat book or other resource recommendations


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


Sponsored Ads