“UbuntuHelp:WikiGuide/Style”的版本间的差异
来自Ubuntu中文
小 |
小 |
||
| （未显示2个用户的4个中间版本） | |||
| 第3行： | 第3行： | ||
Our aim is to make documentation which a new user can easily understand and follow. With this in mind, please take into account the following suggested guidelines: | Our aim is to make documentation which a new user can easily understand and follow. With this in mind, please take into account the following suggested guidelines: | ||
* '''Common guidelines''' - some guidelines which are very common: | * '''Common guidelines''' - some guidelines which are very common: | ||
| − | + | * ''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 just "Ubuntu X.XX" - eg. "Ubuntu 5.10 (Breezy Badger)" or "Ubuntu 5.10", rather than just "Breezy" or "Ubuntu Breezy". | |
| − | + | * ''Repositories'' - capitalize the names of the Universe & Multiverse repositories when you use them. Also, Linux, Ubuntu, Windows, etc should be capitalized. | |
| − | + | * ''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 <code><nowiki>X</nowiki></code> from the <code><nowiki>Y</nowiki></code> repository''". If appropriate, include a link to the page which documents the various package managers, [[UbuntuHelp:InstallingSoftware|InstallingSoftware]]. | |
| − | + | * ''Which software'' - in general, recommend software from the Main repository over equivalent software in the Universe repository, as the former have guaranteed security updates. | |
| − | + | * ''Integrate, don't duplicate!'' - do a comprehensive search of the help wiki before adding material. If a page already exists on a particular subject, don't add a second one with similar material. Integrate the material with the existing page, to improve it. So, new information should be added to the existing page in the appropriate place. | |
| − | * '''Styleguide''' - the Documentation Team has published some specific guidelines for documentation, the [ | + | * '''Styleguide''' - the Documentation Team has published some specific guidelines for documentation, the [[UbuntuWiki:DocumentationTeam/StyleGuide|Documentation|Team Styleguide]]. |
---- | ---- | ||
| − | Go back to WikiGuide | + | Go back to [[UbuntuHelp:WikiGuide|WikiGuide]] |
[[category:UbuntuHelp]] | [[category:UbuntuHelp]] | ||
2009年11月17日 (二) 21:17的最新版本
 |
点击翻译: |
English |
请不要直接编辑翻译本页，本页将定期与来源同步。 |
Our aim is to make documentation which a new user can easily understand and follow. With this in mind, please take into account the following suggested guidelines:
- Common guidelines - some guidelines which are very common:
- 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 just "Ubuntu X.XX" - eg. "Ubuntu 5.10 (Breezy Badger)" or "Ubuntu 5.10", rather than just "Breezy" or "Ubuntu Breezy".
- Repositories - capitalize the names of the Universe & Multiverse repositories when you use them. Also, Linux, Ubuntu, Windows, etc should be capitalized.
- 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
Xfrom theYrepository". If appropriate, include a link to the page which documents the various package managers, InstallingSoftware. - Which software - in general, recommend software from the Main repository over equivalent software in the Universe repository, as the former have guaranteed security updates.
- Integrate, don't duplicate! - do a comprehensive search of the help wiki before adding material. If a page already exists on a particular subject, don't add a second one with similar material. Integrate the material with the existing page, to improve it. So, new information should be added to the existing page in the appropriate place.
- Styleguide - the Documentation Team has published some specific guidelines for documentation, the Documentation|Team Styleguide.
Go back to WikiGuide
