Re: Purpose Statement for Style Guide

Subject: Re: Purpose Statement for Style Guide
From: Janice Gelb <janiceg -at- marvin -dot- eng -dot- sun -dot- com>
To: techwr-l -at- lists -dot- raycomm -dot- com
Date: Thu, 6 Jul 2000 15:47:04 -0700 (PDT)

Rebecca <rebeccam -at- envworld -dot- com> wrote:
| Our new management thinks that our Style Guide is a
| luxury and a waste of
| time. Can you provide me with some well-thought-out
| arguments as to why a
| tech. pubs. team would "need" to have one?

I've done a few presentations on this, which you
may want to look at (URLs below).

Main points include:

* Ease of localization

* Lack of confusion for customers, and therefore
customer confidence in documents

* Writers not having to re-invent the wheel when
faced with similar situations

* Shared vocabulary for indexing

* Enables external groups such as contractors or
marketing to contribute documentation that
blends with your style

You may want to look at the complete style guide
presentation I did a couple of years ago that's
up (in graphics format, sorry) on my home page

I also did a presentation on establishing an editorial
forum for company style guidelines that covers why
style guidelines are necessary. That one is on the
STC presentations web site at

Janice Gelb | The only connection Sun has with
janice -dot- gelb -at- marvin -dot- eng -dot- sun -dot- com | this message is the return address.

Previous by Author: RE: Converting Frame Docs to Word
Next by Author: Re: "Me too!" reviews (was SMEs and me)
Previous by Thread: RE: Purpose Statement for Style Guide
Next by Thread: RE: Purpose Statement for Style Guide

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

Sponsored Ads