特殊:Badtitle/NS100:WikiGuide/WritingGuide

{{#ifexist: :WikiGuide/WritingGuide/zh | | {{#ifexist: WikiGuide/WritingGuide/zh | | {{#ifeq: {{#titleparts:WikiGuide/WritingGuide|1|-1|}} | zh | | }} }} }} {{#ifeq: {{#titleparts:WikiGuide/WritingGuide|1|-1|}} | zh | | }}

1. title Wiki Guide - Writing Guide

<<Include(WikiGuide/Toolkit/MenuBar)>>

Introduction

The pages in this wiki should be as easy to understand and follow as possible. With this in mind, please take into account the following suggested writing style guidelines:

Terminology

• Ubuntu releases - Always try to specify which versions of Ubuntu a page is valid for. When referring to Ubuntu releases, use "Ubuntu X.XX (Nickname)" or "Ubuntu X.XX" - eg. "Ubuntu 5.10 (Breezy Badger)" or "Ubuntu 5.10", rather than just "Breezy" or "Ubuntu Breezy".
• Operating Systems - Capitalize the names of operating systems like Linux, Ubuntu, Windows, etc.
• Repositories - Capitalize the names of the Universe & Multiverse repositories when you use them.
• Installing software - When documenting how to install software, try to avoid recommending a particular package manager (such as apt-get) - instead, simply use an apt link to allow the user to click on the link to install the relevant package. So, for example:
• To enable support for mp3s in Ubuntu, install the ubuntu-restricted-extras package.
• The wiki markup used to make the link in that example is:

[[apt:ubuntu-restricted-extras|install the ''ubuntu-restricted-extras'' package]].

Page Titles

• Be descriptive.
• Avoid using the word "Howto" in the page title (everything here is a howto!).
• Use capital letters and avoid spaces or dashes (WikiName, for example).

Section Headings

• Heading text should be short, clear, and descriptive.
• Capitalize in the following manner:
• Initial uppercase letter for the first word and the last word, regardless of part of speech
• Initial uppercase letter for all nouns, adjectives, and verbs
• Initial uppercase letter for conjunctions of four letters or longer
• Initial uppercase letter for prepositions of four letters or longer
• Initial uppercase letter for prepositions that are part of a phrasal verb
• All lowercase letters for conjunctions, articles, and prepositions of less than four letters

. (Taken from the GNOME Style Guide)

Lists

• Bullet lists of links should take the following form: <Bullet> <Link> <Hyphen> <Sentence>.

. For example:

• Skype - Internet telephony software (closed source).

Further Information

• Documentation|Style Guide - The Documentation Team style guide.

---

Go back to WikiGuide