style: Re: Style Guide
Subject:
Re: Style Guide
From:
"Tabatha Persad" ####@####.####
Date:
9 Apr 2002 03:13:34 -0000
Message-Id: <01d201c1df74$ed230460$0928a8c0@voodoochild>
Hi Joy, et al!
I took a look at the links you provided, and based on what I've read, it
appears the Gnome Style Guide has most everything applicable to suit the
needs of the LDP, but perhaps requires a bit of a re-org.
I found, like you, that KDE was too tag-oriented. I think that since there
are differences between Linuxdoc and Docbook, it might help to point out
what differences users might encounter. Also as long as an author is using
the appropriate tags (and there is one for just about everything), that
should take care of itself, no?
I thought the cross referencing in Jack Lynch's Style Guide was done
extremely well, although if done too much, it can have the effect of making
the user flit from one page to another unnecessarily, possibly taking them
off path.
Strunk's guide is very verbose. This seemed to carry in-depth grammatical
and punctuation issues into great detail. Some of these might make very
good resources and we could make a chapter for them, to let authors get this
kind of information on their own if they are unsure about these types of
things.
I'm going to try and make some sense out of the Gnome Style Guide, and try
to find out what it would take to re-org the contents into a naturally
progressive guide, one that moves more fluidly between topics. I'll see
about presenting a "sample" TOC based on the Gnome guide and submit it here.
It may not be what ends up flying, but it might help too!
Let me know what you think!
Thanks,
Tabatha
----- Original Message -----
From: "Joy Y Goodreau" ####@####.####
To: ####@####.#### ####@####.#### ####@####.####
####@####.#### ####@####.#### ####@####.####
####@####.#### ####@####.#### ####@####.####
Sent: Monday, April 08, 2002 10:21 AM
Subject: Style Guide
> Thank you for your interest in helping to create a style guide for the
LDP.
> The following list has been set up for style guide discussions.
>
> ####@####.####
>
> Please subscribe to the list by sending an empty email message to the
> following address:
>
> ####@####.####
>
> You will receive an email that you will need to reply to in order to
> confirm your subscription.
>
> If you are wishing to review the style guide but do not wish to be on the
> list for the discussion, I will just email you when it is time for review.
>
> I am looking forward to this effort and hope that we will all learn a lot
> from each other and the process.
>
> I have included some links for you to check out to get an idea of other
> style guides. Some are more formal and exhaustive than we are interested
> in. Others are more conversational, but do not cover enough. I welcome all
> your ideas. If you know of other links with style guides online, please
> send the link to the list and what you think is interesting/cool about
> them. Most large technical companies have style guides. I'm hoping we can
> look at formal style guides and come up with something more usable.
>
> *KDE's style guide. (More of a Tagging guide)
>
http://www.google.com/search?q=cache:UtrIQfM0PnQC:i18n.kde.org/doc/markup/+K
DE+%22style+guide%22&hl=en&ie=ISO-8859-1
> )
>
> *Jack Lynch's Style Guide. (Definitely not a paragon of what we want, but
> notice how easy it is to read and figure out what you want to know about.)
> http://newark.rutgers.edu/~jlynch/Writing/
>
> *This is classic Strunk at his best. Although written in 1918, this is
> almost a religious text for technical writers. His rules govern a lot of
> what we do, but it is still not exactly what we are looking for.
> http://www.bartleby.com/141/
>
> *A style guide for journalism--not technical content. Some rules will
> differ, but good to review.
> http://www.economist.com/library/StyleGuide/index.cfm
>
> *Gnome's style guide. There may be everything you need in this document to
> do style, but I am not sure how you find it. Please look at this one if
you
> have a chance. How do we make a document that authors actually consult
when
> writing documentation?
> http://developer.gnome.org/documents/style-guide/
>
>
>
>
>
> Joy Yokley Goodreau
> Linux Information Developer
> LDP Collections Editor
> Ofc. (512) 838-4118
> T/L 678-4118
> ####@####.####
>
>
