Re: Creating a Style Guide

Subject: Re: Creating a Style Guide
From: Barry Campbell <barry -dot- campbell -at- gmail -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Thu, 14 Apr 2005 14:04:00 -0400


On 4/14/05, Poster <Poster -at- aurora -dot- cotse -dot- net> wrote:

> 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. :)

An approach that has worked for me, conceptually, with "my"
programmers and the house style guide:

"You guys use FAQs (Frequently Asked Question files, a staple of the
tech world) all the time, right? Well, think of this as a FAQ file
for writing."

--
Barry Campbell <barry -dot- campbell -at- gmail -dot- com>
http://enrevanche.blogspot.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.



References:
Creating a Style Guide: From: Martin Bosworth
Re: Creating a Style Guide: From: Poster

Previous by Author: Re: Screen Capture Programs?
Next by Author: Re: Client Complaint
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