Re: Creating a Style Guide

Subject: Re: Creating a Style Guide
From: "Janet M. Swisher" <swisher -at- enthought -dot- com>
To: "TECHWR-L" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 15 Apr 2005 10:50:20 -0500


Barry Campbell wrote:
>
> 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."

Or you could describe it as "coding standards for writing". Most professional programmers understand why they need to follow the house coding standards, even if they disagree with it on things like the best placement for brackets. They should be able to understand that the same principles apply to standards for writing.

--
Janet Swisher --- Senior Technical Writer
Enthought, Inc. http://www.enthought.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.



Previous by Author: Re: I'm looking for a word...
Next by Author: Re: Trouble finding work
Previous by Thread: Re: Creating a Style Guide
Next by Thread: ITCA


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

Sponsored Ads


Sponsored Ads