Re: Creating a Style Guide

Subject: Re: Creating a Style Guide
From: "Poster" <Poster -at- aurora -dot- cotse -dot- net>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 14 Apr 2005 13:50:56 -0400 (EDT)


Martin Bosworth said:
> 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"


Creating a style guide for tech writers is a good and a useful thing.
For other departments? Your mileage will definitely vary. Generally
I've found that developers tend to think that they rule the world
(perhaps it's some of the old "programmer rock star" mentality that is
hanging around) and they won't listen to a "lowly" technical writer.
(When management beats them with a stick, it's different, however. :)
)

To get their buy in, I think you'd have to stress how the quality of
their input is causing delays and rework for you. Point to specific
examples and reassure them that it's not a personal attack; it's a
process problem. Then suggest the style guide as a common reference
point for everyone. If you management or the process folks involved,
it would stand an even better chance of adoption.

~Poster


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

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:

References:
Creating a Style Guide: From: Martin Bosworth

Previous by Author: Re: RoboHelp For Word Crash/Reboot Problem
Next by Author: Re: I have proof
Previous by Thread: Re: Creating a style guide?
Next by Thread: Re: Creating a Style Guide


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

Sponsored Ads


Sponsored Ads