StyleGuide

Differences between revisions 8 and 18 (spanning 10 versions)
Revision 8 as of 2007-12-16 21:10:10
Size: 3099
Editor: cpc3-with4-0-0-cust1001
Comment: Changed TOC type
Revision 18 as of 2014-07-02 23:40:07
Size: 3466
Editor: bregma
Comment: Added the TOC so the rest of the style guide could be found frmo the landing page.
Deletions are marked like this. Additions are marked like this.
Line 2: Line 2:
<<Include(Tag/ContentCleanup)>>
<<Include(Tag/StyleCleanup)>>
<<Include(Tag/NeedsExpansion)>>
Line 3: Line 6:
||<tablestyle="float:right; font-size: 0.9em; background:#F1F1ED;margin: 0 0 1em 1em;" style="padding:2.0em;">[[Include(DocumentationTeam/StyleGuide/TableOfContents)]]|| <<Include(DocumentationTeam/MenuBar)>>
<<Include(DocumentationTeam/MeetingBanner)>>
Line 5: Line 9:
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). This document is the style guide for the Ubuntu [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]]. The Ubuntu Documentation Style Guide is built with the participation of the members of the Ubuntu [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]], and represents the current accepted practice for documents produced and maintained by the [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]]. The guide is still missing a couple of items (marked TODO).
Line 7: Line 11:
= Introduction = ||<tablestyle="float:right; font-size: 0.9em; background:#F1F1ED;margin: 0 0 1em 1em;" style="padding:2.0em;"><<Include(DocumentationTeam/StyleGuide/TableOfContents)>>||
Line 13: Line 17:
This document is a collaborative effort of the Ubuntu documentation team. The contributors are: This document is a collaborative effort of the Ubuntu [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]]. The primary contributors are:
Line 21: Line 25:
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. A style guide is a reference used by writers and editors. It is an outline of the policies and standards that writers and editors are expected to follow.
Line 23: Line 27:
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.
The Ubuntu [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]] needs its own style guide because Ubuntu is unique. Ubuntu is Linux + GNU + Debian + (GNOME, KDE, and XFCE) + the Ubuntu philosophy. No style guide covers the entire spectrum of Ubuntu components.
Line 32: Line 34:
 * 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.
 * Highlight common problems in the use of the English language and to provide solutions.
 * Help documentation authors write for an international audience, including how to write for translation.
Line 44: Line 46:
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 [:DocumentationTeam/Repository:repository]. The Ubuntu style guide is applicable to all documents produced by or for the Ubuntu [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]]. It covers all documents in the Documentation Team's [[DocumentationTeam/Repository|repository]]. The [[https://wiki.ubuntu.com/DocumentationTeam|Documentation Team]] also takes care of the [[https://help.ubuntu.com/community|documentation wiki]], to which the style guide also applies.
Line 46: Line 48:
The docteam also takes care of the [https://help.ubuntu.com/community 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, refer to the [[http://library.gnome.org/devel/gdp-style-guide/|GNOME Documentation Style Guide]]. If your document deals exclusively with KDE, refer to the [[http://i18n.kde.org/docs/styleguide/index.html|KDE Style Guide]].
Line 48: Line 50:
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 [:/ReferenceMaterials:Reference Materials] section for links to other style guides and documentation handbooks.
If none of the above guides offer a solution to your problem, you will have to make your own decision. See the section [[/ReferenceMaterials|Reference Materials]] for links to other style guides and documentation handbooks.

Tag/tag.png

Content Cleanup Required
This article should be cleaned-up to follow the content standards in the Wiki Guide. More info...

Tag/tag.png

Style Cleanup Required
This article does not follow the style standards in the Wiki Guide. More info...

Tag/tag.png

Needs Expansion
This article is incomplete, and needs to be expanded. More info...

Inclusion deadlines for ImpishString Freeze: September 16, 2021 / Non-language packs: September 30, 2021

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 Documentation Team. 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 primary contributors are:

  • Jeff Schering
  • Jerome Gotangco
  • David Ottina

Overview of the Style Guide

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

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

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 documentation authors 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 Documentation Team also takes care of the documentation wiki, to which the style guide also applies.

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

If none of the above guides offer a solution to your problem, you will have to make your own decision. See the section Reference Materials for links to other style guides and documentation handbooks.


CategoryDocteam

DocumentationTeam/StyleGuide (last edited 2014-07-02 23:40:07 by bregma)