Style Guide: Ubuntu nomenclature proposal redux
Jeff Schering
jeffschering at gmail.com
Fri Apr 29 19:42:14 UTC 2005
Hi
I incorporated some of the suggestions and comments, and did some
reorganization:
--------------------------------------------------
1. Use "Ubuntu operating system" the first time you refer to Ubuntu,
then use "Ubuntu" thereafter.
You can use the terms "Ubuntu system" and "Ubuntu environment" when
they are more appropriate than "Ubuntu operating system."
You can use "Ubuntu Linux distribution" or "Ubuntu Linux distro,"
but try to reserve those terms for audiences who do not need to have
"distribution" or "distro" explained to them.
You can use Kubuntu, Kubuntu system, Kubuntu environment, and Kubuntu
distribution when referring to Ubuntu with the KDE desktop, but
remember that it is still the Ubuntu operating system, not the Kubuntu
operating system.
2. Use "... based on Debian GNU/Linux..." when referring to Ubuntu's
Debian roots.
3. Use "... Linux-based..." when referring to Ubuntu's kernel roots.
4. You might find that you must use the term "Ubuntu Linux". If so, then
try to work in the phrase "based on Debian GNU/Linux".
5. If you use any of these terms, (Debian, GNU/Linux, Linux,
distribution, distro) you must explain them in the text following
their first use, as well as in the glossary (if there is a glossary).
The only exception is when the audience of the document is already
knowledgeable about the terms.
6. If there is an About Ubuntu section in your document, then describe
Ubuntu and its genealogy, including GNU/Linux, Debian, and the Linux
kernel.
-------------------------------------------------
Here are my replies to a couple of suggestions in the feedback, but
not incorporated:
<mary>
An exception for hyperlinked documents could perhaps be made here by
giving a link to a glossary as an alternative to in-line explanation?
</mary>
In general, when a term is introduced to an audience, the word is
defined in-line, italicized, and a glossary entry is made (if there is
a glossary). This is true even in hyperlinked documents because
forcing the reader to a new page for a definition can be disruptive
and distracting. Readers who already know the meaning of the term can
easily skim over it.
<sean>
I would however like there to be some ground references to works such as
Chicago Manual of Style, Sun Manual of Style. Bibliography would be good.
</sean>
Yes. I'll start another thread for this.
Cheers,
Jeff
--
GPG Key: 1024D/F23C67E8 2005-02-20 Jeff Schering <jeffschering at gmail.com>
More information about the ubuntu-doc
mailing list