文档编辑规范

来自WordPress中文文档
跳转至: 导航, 搜索
欢迎你! 
为了使文档具有可读性和可继承性,在这里强调一下编辑者所应遵守的规范。

目录

基本原则

  1. 在拼写WordPress时请注意大小写: WordPress
  2. 友善第一 - 禁止个人攻击和脏言脏语。尽量做到专业、有礼貌、和耐心。
  3. 翻译作品时尽量准确、及时和经常性。
  4. 在编辑时发现错误不要留面子。
  5. 假如有任何疑问,不要犹豫 -- 提问!
  6. 尽情享受你无私贡献带来的所有快乐 :)

翻译标准化

新页面

欢迎创建新文章和新页面,不过需要按照一定的程序。

如果你还没有注册,请先注册。参照:文档中文翻译贡献:首先要做的事

如果你的文章基本完毕,你可以将它添加以作为一个新页面。参照: 创建新页面.

如果你的文章还是未完成的草稿,你可以把它加为你个人页的子页。参照:创建用户个人页面.

写文章请按照这些成文的格式标准: Codex 格式.

下面是编辑规范指南:

  1. 如果你想要编辑的文章已存在,改进它。
  2. 沙盒练习实现你想要的式样,不要在原文档做试验。
  3. 在你试图添加一篇新的文章的时候,先在某篇相关的文章建立链接,指向你所编辑的文章。不要轻易删除文档之间的链接,这很可能导致某篇文章成为一片孤立的文章,再也不轻易为人所知。
  4. 当页面建立后,任何指向它的链接将会以绿颜色标记出来。当一个用户点击它的时候,他不希望他在浪费时间。所以当你有足够多内容的时候才试图建立新页面。
  5. 一旦你在页面完毕后想将其从个人页下移至到文档条目时,你最好在“子”条目或者其他相关文档里建立连向你新页面的链接。假如你不是很确定在“子”条目什么地方添加这个链接,请问我们。没有得到文档翻译中文团体允许之前,尽量不要在首页上新添链接。

下面是可使用的 "stubs(标记)"分类来代表你文章的编辑状况:

{{Stub}} 
Stub 分类表示该页面还“没有完毕”,尚需编辑和扩充。
{{Draft}} 
这个应该放在文章的顶部。所有加入文档的页面都会被搜索引擎扫描到。这个在页面顶部的 Draft 字样可以警告其他用户该页面仍在建设中;里面的内容可能不是十分正确,或者告诉别人先不要编辑因为你正在翻译它。
[[Category:最新页面]] 
标记为新页面进而引起编辑团队的注意。只在你已准备将你的页面从个人页面移至正常的文档页面里时使用。
{{Copyedit}} 
Copyedit 表示这篇文章还需一定的工作,一般是指需要进一步的审阅和编辑。这个标记是指文章基本上完成了,如果你的文章还是草稿,请使用 {{Stub}} 标记。

标题

请尽量使用中文和具有可读性的标题. 标题非常重要,在建立一个新页面的时候,确定好你的标题,修改标题有可能导致一系列的问题。

  1. 使用描述性的标题,比如“使用链接编辑器”比用“链接编辑器”要好,想一想用户在查找信息的时候会使用什么关键词?
  2. 标题前面不要有空格,标题之间也不要有多余的空格。尽量避免使用以下字符 "-", "#", "?" and "+"
  3. 标题越短越好,当然前提是描述清楚。
  4. 尽量不要在标题里使用介词。
  5. 由于该文档集就是关于 WordPress 的帮助文档,每个标题再有 "WordPress" 就显得多余了。
  6. 如果你在翻译文章,请尽量不要修改英文标题,先编辑英文标题页面再重定向到中文标题页面不会破坏整个文档的组织性。如果想修改显示地址,比如[[I'm a pig]],请不要翻译成[[我是猪]],请使用[[I'm a pig|我是猪]]


子页面

尽量不要新建子页面,除非你认为非常有必要。这会打乱整个文档的布局结构。

讨论

使用"讨论"页面

在讨论页面你可以发表你对于文档页面的看法,建议,和任何你想说的东西,当然,拒绝垃圾信息.

  1. 发表关于本文的评论: 想给你浏览的页面发表评论, 点击文章上的 讨论 然后书写评论,然后签名、提交你的评论。
  2. 给用户留言: 想给其他用户留言,可以修改那个用户的 User:Talk 页面, 然后签名。但那个用户下次登陆后,他就会收到新留言的通知。
  3. 分隔留言: 在讨论页面上的不同留言之间用四个小横线 ---- 可以生成一条分隔线。 如果你是在生成一个新的讨论主题,可以考虑使用 "+" 链接。
  4. 总是给你的留言签名: 在你的留言后面使用四个 ~ (波浪线) 可以生成你的签名。这样可以列出的用户名、一个连向你个人页面的链接,以及留言时间。这些在讨论页上都是很有用的。另一个生成签名的办法就是点击编辑窗口里的签名按钮(从右边数第二个)。

文档所应用的语调、风格和文档的读者

WordPress 中文文档所用的“语调”应该读起来就好象作者与读者进行朋友般之间的对话。整个中文文档风格是教育为主,给读者提供一些简单而又容易懂的帮助说明,在必要的时候给与一些技术上的建议。.

一般来讲,文章是写给“读者”看的,帮助读者解决问题。尽量不要在文档里出现“我”,而是用“你可以点击这里”或者“你打开模板文件”等字样。因为帮助文档不是讲关于作者你,或你们团队的故事,而是要帮助那些想法将自己的WordPress博客站建好并能快速运行的普通读者。

“分几步”、“分几点”的列表一般是用来强调一些必须的流程、步骤。这样可以将一些复杂的过程解释清楚,

由于广大的文档读者具有不同的 HMTL, XHTML, CSS, 和 PHP 技术知识。所以在进阶课题开发文件里的文章是针对于那些有经验的高级读者。而WordPress 教程是专为那些新手设计的,使用的语言读起来使作者就象坐在用户电脑旁的一个技术支持员,手把手地指导用户。 其他帮助文档就是针对那些初级到中级的读者,文档里应该使用简单的语言。有必要,可以含有指向技术词汇的链接。

惯例

  1. 域名实例: 当你需要列举一个域名的例子时,总是使用example.com, example.orgexample.net 不要使用私人域名。这个规定是来自于RFC2606
  2. 管理用户名: WordPress默认管理用户名admin
  3. 在例子中使用人名: 当一个普通的非管理员用户需要提及名字时,用"Harriet" 作为名,而 "Smith" 作为姓。
  4. WordPress 正确拼写是 WordPress: WordPress 按 TWO 惯例将组成的两个单词第一个字母大写: WordPress。

相关文档

用户
名字空间

变换
操作
导航
WordPress
工具箱