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.
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
at http://www.geocities.com/j_gelb/gfx001.html
***********************************************************************
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. http://www.geocities.com/Area51/8018/index.html