Article naming guideline 文章命名规则(简体中文)

From ArchWiki

Jump to: navigation, search


i18n
English
简体中文
对wiki的编辑者来说,文章命名是最终要的任务中的一项
这篇文章是一个命名的指标,也是现有ArchWiki的作者和编辑者为他们文章命名时应该考虑的

Contents

[edit] 关于文章名称

文章名字包含两个意图. 它们是ArchWiki上内容的标识符. 它们也能让读者知道文章的内容. 也就是说一个文章的标题必须是独一无二而又具有描述性的.

有时,文章标题反映出文章的类型, 也有时提供出额外的信息,如文章编辑的语言.

[edit] 描述性的名称

名称越详细精确越好,而且必须反映包括内容的范围

Documentation projects are seldom like software/hardware reviews commonly seen in newspapers and news sites. Documentation is usually read when some problem arises, or some other specific need has to be met. Therefore, quick identification of those needs and swift solution is of utmost importance. For improved readability and faster access to information, article names (and, therefore, their titles) should be as descriptive and specific as the article scope permits.

[edit] 例子

类似'Boost Pacman'的名称可能会让大多数读者误解. 某些读者可能看成boos某些方面,也就是对pacman喝倒彩,但是这些方面并不是作者描述的.名称必须详细精确,也不能对别人快速浏览来说太长. 例如这篇 example article 就应该改成类似 How to improve pacman download speed using wget, snarf, and lftp.

[edit] 允许的对名称增强

名称必须比较全面,以方便以后对文章内容的扩展

In order to allow room for future edits and enhancements, an article's name sometimes needs to be less specific. Of course, making article names less specific just for the sake of shortening it is not a good idea. On the other hand, if you think you have covered all the bases, and that no future edits will enhance the article's scope, make your article's name as specific as possible.

[edit] 例子

Let us go back to the previous example. The new title of the article is Improve pacman download speed using wget, snarf, and lftp. However, some day, new download mangers may emerge that would replace or become an alternative to wget, snarf, and/or lftp. This calls for a more generic title, something like: How to improve pacman download speed using alternative download managers.

[edit] 简短的名称

名称必须精简

Making article names short is important in order to allow quick scanning of article listings. Many people use the browsing technique when reading wikis, so you don't want to waste their time by writing article names that are miles long. Also, shorter names tend to sound more professional.

[edit] 例子

Using the long article name we have deviced in the previous examples (How to improve pacman download speed using alternative download managers), we will demonstrate how to shorten the title in a separate article.

[edit] 文章类型的后缀 (推荐)

名称必须有一个类型后缀

注意: 这只是一个建议, 并不是规则. 你只需要考虑到, 但不一定非要遵循.

Although the type of the article is not critical, it is more than helpful when readers are trying to find a quick rather than complete solution to a problem. For instance, HOWTOs are considered a short, step-by-step guide for a simple task, whereas Tutorials are considered a much more complete guides on how to carry out many related tasks.

To help readers understand what type of documents are available, ArchWiki has its pages sorted both by topic and by by type. If you look at the latter section, you will see all the possible article types that are available to wiki writers and editors.

Use the following table as a reference for article type siffixes:

article type suffix (in italics) type description
HOWTO Article title HOWTO Short, step-by-step procedures for carrying out a single task
Tutorial Article title tutorial Longer, comprehensive guides to carrying out a set of related tasks
FAQ Article title FAQ Q and A type of articles of varying length
General (no suffix) General articles that do not cover any specific task, procedure, or guidelines
Guideline Article title guideline Standards for community behavior or carrying out a task or a set of taks.
Book Article title book book Container article for multiple related tutorials

慎重: 文章名称的后缀需要适应大多数情况. 如果你决定使用这个, 需要考虑文章名称时候适应后缀.

[edit] 多语言文章

名称需要有一个标识

要知道,不是只有英文用户阅读ArchWiki. 文章也需要在名称后面加上语言标识. 到写这文章为止,还不能自动完成这工作。

一个语言标识就是在文章名称后面加上 "_(语言)"(把语言 题换成适当的语言). 每篇文章都需要有"_(语言)"这样的语言标识加在名称的后面.

注意: 通常, 绝大多数ArchWiki 没有语言标识,因为英文文章被认为是后来被翻译成别的语言文章的基础文章. 这一点有希望改变, 所以上述规则仍然有效.

[edit] 例子

举例说明,如果你有一篇文章叫做Pacman (English), 你就应该叫中文翻译文章为 Pacman (简体中文), 而塞尔维亚版本叫 Pacman (српски).

[edit] 注意事项

这个指标是个起作用的版本, 但是这里的规则任何时候都可能更改. 所以你可能希望对这篇文章作标记,通过文章下方的"Watch this page"链接,然后通过导航栏上右边"My watchlist"来关注本文的变化.

Personal tools