Home Wiki > SDB-Howto-FAQ
Sign up | Login

SDB-Howto-FAQ

tagline: From openSUSE

Susemini.png 本文处于需要修订的文章的状态,欢迎您积极参与翻译与修订。 翻译人员:multiple1902,修订人员:无。


这篇文章介绍了SDB(支持数据库), Howto和FAQ文章的区别.

SDB(支持数据库)

SDB(SupportDataBase,支持数据库)是一款有历史的SUSE工具. openSUSE的维基上线后, SDB被移植过来了, 使得非SUSE/Novell雇员也可以添加自己的文章. 为了确保SDB的整洁, 需要遵守以下规则:

  • 编辑行为应当是被动的. 如果没有什么问题, 没必要去写一篇SDB文章. 当然, 你不必因为这条规则而不去SDB之外写点什么.
  • 直击要点, 一语中的. 是的, 你是应该写得足够详细, 但是要知道, 用户要的是一个又快又能解决问题的方案. 可以用链接加入更多的信息.
  • 越简单越好. 如果解决一个问题有多种方法, 给出最简单的那个. 复杂一点的方法可以用"also"列出来, 比如, 控制台操作和YaST的对比.
  • 要关于openSUSE. 核心是把openSUSE作为工具解决问题, 用到的程序应该是大家都安装了的. 比如, Emacs是个很棒的编辑器, 但openSUSE的默认安装中并没有包含它.
  • SDB的页面设计不需要创新: 阅读SDB Howto.
  • 记得使用 SDB: 名字空间, 并且添加一个到 SDB:History 页的链接.


Howto

根据维基百科英文版中的定义: "How to, 或者说howto, 是指完成一个特定任务的步骤的非正式的, 通常很短的介绍. How to通常是用来帮助入门用户的, 所以不包括一些对于高级用户才有意义的内容. How to还可以作为对整个话题讨论的简单总结."

A Howto gives you more freedom compared to the SDB. Basicly you can forget every SDB rule, or transform them: 和SDB相比, Howto给作者更多的自由, 因为你可以忽略每一个SDB规则, 或者说, 只需要这些:

  • 编辑行为是积极主动的. HOWTO应该包括要在openSUSE上完成的东西, 而不是关于解决已经存在的问题(那是[SDB]的工作).
  • 描述要足够详细. 需要解释的话, 就解释吧.
  • 没有简单的规则, 不过记住这一点: 你把东西阐述得越清楚, 你可能就能帮到越多的人.
  • 记得使用 howto: 名字空间, 并且添加一个到 Howtos 页的链接.


FAQ

根据维基百科英文版中的定义: "FAQ是"Frequently Asked Question(s)"(经常被提出的问题, 也就是常见问题)的首字母所写. 它指的是在某个上下文中, 关于某个话题, 列出来的提问和对应的回答."

  • 要简短
  • 想想什么才真的是常见的问题
  • 不要把FAQ转载到别的地方. 用一个到这里的链接, 避免内容过期
  • 用 FAQ: 名字空间


其他

如果你还是不确定你要找的文档在哪里, 或者你编写的文档应该在哪里:

  • 在 opensuse-wiki 邮件列表上提问吧
  • 在你创建的页面名称中, 不要使用名字空间或者前缀 (有必要的话, 会有人来移动它们的).
  • 不要被这些规则吓到. 尽管写吧.
  • openSUSE的我们, 都很友善的.
  • 因此所有对文章的移动和修改, 都是抱着善意的.
  • 对其他人的操作有不同看法的话, 在讨论页(Discussion page)上把你的观点告诉别的编辑.