Creating a Style Guide

Subject: Creating a Style Guide
From: Martin Bosworth <martinhbosworth -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 14 Apr 2005 10:06:05 -0400


In my new job here at Walter Reed, I've discovered that the
developers' documentation is generally solid and easy to understand,
but it's rife with grammatical errors and inconsistent style usage
that defeats the purpose...things like capitalizing "telepsychiatry"
when referring to the general profession, rather than a particular
department. (Imagine capitalizing "psychiatry" every time you referred
to it in a sentence.)

The primary app developers do not speak English as a first language,
so they often miss contextual cues and best standards, such as using
"he/she" constantly as opposed to "they", or avoiding gender-neutral
language altogether.

I've been pondering whether or not I should create a style guide for
the department to refer to, both to improve their skills and free me
up to concentrate on more creative projects. But I have never done
this before. Is it the right course of action to take, and if it is,
what're some good suggestions or resources I can use in its creation?

Martin


--
Martin H. Bosworth
Technical Writer, Telemedicine Directorate
Walter Reed Army Medical Center (http://www.wramc.amedd.army.mil/)
Writer/Editor, ConsumerAffairs.com (http://www.consumeraffairs.com)

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

WEBWORKS FINALDRAFT - EDIT AND REVIEW, REDEFINED
Accelerate the document lifecycle with full online discussions and unique feedback-management capabilities. Unlimited, efficient reviews for Word
and FrameMaker authors. Live, online demo:
http://www.webworks.com/techwr-l

---
You are currently subscribed to techwr-l as:
archiver -at- techwr-l -dot- com
To unsubscribe send a blank email to leave-techwr-l-obscured -at- lists -dot- techwr-l -dot- com
Send administrative questions to lisa -at- techwr-l -dot- com -dot- Visit
http://www.techwr-l.com/techwhirl/ for more resources and info.



Follow-Ups:

Previous by Author: Re: "I write the labels" ad
Next by Author: Re: Start at the very beginning...
Previous by Thread: RE: I have proof
Next by Thread: Creating a style guide?


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

Sponsored Ads


Sponsored Ads