[joyg@us.ibm.com: LDP Style Guide]
Perhaps some people here would be interested in this for Debian
documentation development as well?
--
Colin Watson [cjwatson@flatline.org.uk]
----- Forwarded message from Joy Y Goodreau <joyg@us.ibm.com> -----
Mailing-List: contact discuss-help@linuxdoc.org; run by ezmlm
X-No-Archive: yes
List-Post: <mailto:discuss@linuxdoc.org>
List-Help: <mailto:discuss-help@linuxdoc.org>
List-Unsubscribe: <mailto:discuss-unsubscribe-cjwatson=flatline.org.uk@linuxdoc.org>
List-Subscribe: <mailto:discuss-subscribe@linuxdoc.org>
Delivered-To: mailing list discuss@linuxdoc.org
Subject: LDP Style Guide
To: discuss@linuxdoc.org
From: "Joy Y Goodreau" <joyg@us.ibm.com>
Date: Tue, 19 Mar 2002 12:29:04 -0600
X-MIMETrack: Serialize by Router on D01ML072/01/M/IBM(Release 5.0.9a |January 28, 2002) at
03/19/2002 01:29:05 PM
X-Spam-Status: No, hits=0.0 required=5.0 tests= version=2.11
I am interested in putting together a style guide for the LDP to guide
reviewers and authors in publishing and maintaining high quality
documentation. Unlike other Style Guide projects in existence, this would
be tailored towards developers, not toward individuals who already know
what "gerund phrases" and "dangling participles" are. In fact, this Guide
will try a new approach to style by providing an easy-to-use reference for
style that includes, instead of excluding, would be writers.
A survey of some possible topics that could be covered in this guide
follows: abbreviations and acronyms, punctuation, verb tenses, basic
sentence structure, bulleted lists, and more. this will not be a
comprehensive guide for all style concerns, but it will be a quick
reference for LDP Style issues.
To volunteer for one of the positions listed below, please contact me off
list (joyg@us.ibm.com).
WRITERS: Volunteers to Design Style Guide
These writers should fit the following criteria:
1. Believe that arcane terminology for grammar is not as important as
making style guidelines clear.
2. Have worked as technical writers, understand documentation and grammar
used with technical content.
3. Willing to investigate different ways of writing, and present style
concerns for consideration.
4. Welcome a little positive criticism.
5. Open to new ideas--not married to the way that their company, school, or
past experience has told them to write.
6. Willing to resolve conflict.
7. Willing to invest some time every week in the project.
REVIEWERS: Experienced Writers to Review the Style Guide
These reviewers should fit the following criteria:
1. Experience writing several HOWTOs or other forms of technical
documentation.
2. Willing to use Style Guide as writing tool.
3. Willing to give positive critical feedback to Style Guide designers.
REVIEWERS: Inexperienced Writers to Review the Style Guide
These developers or programmers should fit the following criteria:
1. Willing to use the Style Guide as a writing tool.
2. Willing to share feedback with Style Guide designers.
REVIEWERS: ESL (English as Second Language) Writers to Review the Style
Guide
These reviewers should be non-native English speakers who are able to do
the following:
1. Willing to use the Style Guide as a writing tool.
2. Willing to share feedback with Style Guide designers.
Joy Yokley Goodreau
Linux Information Development
IBM Linux Technology Services
512-838-4118
joyg@us.ibm.com
_________________________
http://list.linuxdoc.org/
----- End forwarded message -----
Reply to: