WikiGuide/Style

来自Ubuntu中文
跳到导航跳到搜索

我们的目标是：把文档做得让新手浅显易懂。抱着这种想法，请考虑下面推荐的准则：

  • 通用准则 - 一些常用的准则：
    • Ubuntu发行版 - 不要忘了写清楚该页文档适用的Ubuntu版本。说明Ubuntu发行版时，要使用 "Ubuntu X.XX (昵称)" 或者 "Ubuntu X.XX" - 例如. "Ubuntu 5.10 (Breezy Badger)" 或 "Ubuntu 5.10"， 不要光写 "Breezy" 或 "Ubuntu Breezy"。
    • 软件库 - 提到 Universe & Multiverse 软件库时首字母要大写。Linux、 Ubuntu、 Windows 等也应同样处理。
    • 安装软件 - 当写安装文档时，请避免推荐某个包管理器（例如“apt-get”） - 而应简单地使用"从 Y 软件库中安装 X 包"的措辞。可行的话，在文中加一个介绍多个包管理器的文档链接，安装软件。
    • 软件选择 - 一般来说，Main软件库和Universe软件库的类似软件，推荐用前者，因为它有安全更新。
    • 百川汇海! - 提交材料前在维基帮助上仔细搜索一下。如果某个主题已经有页面存在，请不要在添第二个相似的上去。应改进存在的页面，把自己的材料和它融合在一起。新内容加到合适的地方去。
  • 风格指南 - 文档小组已经发布了一些具体的编写准则，文档小组风格指南。

返回 WikiGuide

<tablewidth="100%" #FF8080>英文原文

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 X from the Y repository". 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


原文出处：https://help.ubuntu.com/community/WikiGuide/Style

原文作者：

授权许可：创作共用协议Attribution-ShareAlike 2.0

翻译人员：spider5

校对人员：

贡献者：

适用版本：

文章状态：等待校正

取自“https://wiki.ubuntu.org.cn/index.php?title=WikiGuide/Style&oldid=21111”