discuss: LDP Style Guide
Subject:
Re: LDP Style Guide
From:
superk ####@####.####
Date:
19 Mar 2002 20:07:17 -0000
Message-Id:
Le 19 Mars 2002 13:29, vous avez écrit :
> 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.
this is a great idea! I started working on that sort of guide a while ago at
Mandrake, but more urgent tasks have... urged me to leave it aside.
> 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.
this is exactly what I have in mind.
> To volunteer for one of the positions listed below, please contact me off
> list ####@####.####
>
> 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.
I'm willing to help out for that section.
> 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.
a few translators at Mandrake might be interested by that part of your
project, i will forward the mail.
K