StyleGuide

Revision 11 as of 2008-08-06 16:37:27

Clear message

This document is the style guide for the Ubuntu documentation team. 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. The guide is still missing a couple of items (marked TODO).

Acknowledgments

This document is in the Public Domain.

This document is a collaborative effort of the Ubuntu documentation team. The contributors are:

  • Jeff Schering
  • Jerome Gotangco
  • David Ottina

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:

  • Help writers communicate clearly.
  • Create a consistent style across all documents.
  • Create a consistent use of terminology across all documents.
  • Highlight common problems in the use of the English language, and to provide solutions.
  • Help writers write for an international audience, including how to write for translation.
  • 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 here for convenience.

Style Guide Applicability and Precedence

The Ubuntu style guide is applicable to all documents produced by or for the Ubuntu documentation team. It covers all documents in the Documentation Team's repository.

The docteam also takes care of the documentation wiki; the style guide is also applicable to those pages.

If you encounter a topic or situation that is not covered by this style guide, then refer to the GNOME Documentation Style Guide. If your document deals exclusively with KDE, then refer to the KDE Style Guide.

If you have still not found a solution after referring to one of the guides above, then you will have to make your own decision. See the Reference Materials section for links to other style guides and documentation handbooks.


CategoryDocteam