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: Fri, 13 Apr 2007 16:24:31 +0800

"IBM Style provides consistency guidelines for IBM information.
The guidelines cover all areas of the business: hardware, software,
mainframe, workstation, and more. These guidelines are developed and
maintained by a committee of technical editors from each IBM Division
around the world who ensure that the guidelines address a global
audience that uses a wide range of IBM products."

You can download a copy from:
http://www-03.ibm.com/easy/page/1387

The general IBM 'Ease of Use' portal, containing other style guides,
downloads and resources, is at:
http://www-03.ibm.com/easy/page/558


One other reference you might find useful: a book called Developing
Quality Technical Information.
(http://www.amazon.com/Developing-Quality-Technical-Information-Handbook/dp/0137903200)

It was written by a group of writers and editors at IBM. They're mostly
the people who maintain the IBM Style guide and Word Usage DB, so the
book complements the online resources nicely. In fact, the in-house
version of IBM Style has a reference at the bottom of each topic to the
corresponding section in DQTI.

Sun's "Read Me First! A Style Guide for the Computer Industry" is an
excellent short guide to the most common questions and problems faced by
working tech writers. I haven't seen the second edition but I assume
it's like the first edition, only better.

Regards

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: Problem Co-worker
Next by Author: Re: "Collect for Output" type function in FrameMaker 7?
Previous by Thread: Re: Style guides
Next by Thread: Re: Style guides


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


Sponsored Ads