“UbuntuHelp:WikiGuide/WritingGuide”的版本间的差异
来自Ubuntu中文
小 (新页面: {{From|https://help.ubuntu.com/community/WikiGuide/WritingGuide}} {{Languages|UbuntuHelp:WikiGuide/WritingGuide}} #title Wiki Guide - Writing Guide == Introduction == The pages in this wi...) |
小 |
||
第2行: | 第2行: | ||
{{Languages|UbuntuHelp:WikiGuide/WritingGuide}} | {{Languages|UbuntuHelp:WikiGuide/WritingGuide}} | ||
#title Wiki Guide - Writing Guide | #title Wiki Guide - Writing Guide | ||
+ | <<Include([[UbuntuHelp:WikiGuide|WikiGuide]]/Toolkit/MenuBar)>> | ||
== Introduction == | == 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: | 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: |
2008年12月16日 (二) 20:51的版本
点击翻译: |
English |
请不要直接编辑翻译本页,本页将定期与来源同步。 |
- 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 the phrase "Install package
X
from theY
repository". If appropriate, include a link to the InstallingSoftware page, which has documentation on the various package managers.
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