Style Guide completion

Jerome Gotangco jgotangco at gmail.com
Thu Aug 4 11:26:02 UTC 2005


Hi all,

The Ubuntu Style Guide is almost complete, and just need some final
revisions in the coming days!

Many thanks to Jeff Schering for leading this wonderful piece of work.
For those currently with svn access please review (or even contribute
further) the document! We should have a viewable version online or in
PDF form soon. Once we have agreed to release it as 1.0, all people
involved in the Ubuntu Documentation Project should adhere to the
Ubuntu Style Guide before consulting other style guides (such as the
GNOME and KDE styleguides).


Overview of the Style Guide

A style guide is a reference tool used by writers and editors. It is
an outline of the policies and standards that writers and editors are
expected to work to.

The Ubuntu documentation team needs its own style guide because Ubuntu
is unique. Ubuntu is Linux + GNU + Debian + (GNOME and KDE) + the
Ubuntu philosophy. No style guide covers the entire spectrum of Ubuntu
components.

The Ubuntu Documentation Style Guide is built with the participation
of the members of the Ubuntu documentation team, and represents the
current accepted practice for documents produced and maintained by the
docteam.

This style guide attempts to achieve the following:

1. Help writers communicate clearly.
2. Create a consistent style across all documents.
3. Create a consistent use of terminology across all documents.
4. Highlight common problems in the use of the English language, and
to provide solutions
5. Help writers write for an international audience, including how to
write for translation.
6. Help writers and editors select the appropriate DocBook markup.


This style guide contains three main types of information:

1. Material that is unique to Ubuntu documentation.
2. Material that may be helpful to writers, but is not covered in other guides.
3. Material that is covered in other guides, but is either summarized
or repeated in the Ubuntu Style Guide for convenience.

-- 
Cheers!

Jerome G.




More information about the ubuntu-doc mailing list