Home Wiki > SDB:FAQ
Sign up | Login

SDB:FAQ

tagline: From openSUSE


This article shows the differences between SDB, Howto and FAQ.

SDB

The SupportDataBase is a long time used openSUSE tool to help users. To keep the SDB clean, some rules should be respected:

  • It's reactive. If there is no problem, there is no need for a SDB article. This should not stop you to write something outside the SDB.
  • It's straight to the point. Be verbose but keep in mind that users want a quick solution. If there is more information: link to it.
  • It's easy. There are several ways to solve a problem, use the easiest. It's ok to describe it also in a more advanced way, e.g. console vs. the YaST way.
  • It's about openSUSE. Use openSUSE tools to solve a problem, use what everybody has installed. Emacs might be a powerful editor, but it's not in the default installation.
  • The SDB is not a place to be creative in page design, read the SDB howto
  • Use the SDB: namespace and adequate SDB categories.

Howto

From the wikipedia definition: "A how-to or a howto is an informal, often short, description of how to accomplish some specific task. A how-to is generally meant to help non-experts, may leave out details that are only important to experts, and may also be greatly simplified from an overall discussion of the topic."

A Howto gives you more freedom compared to the SDB. Basicly you can forget every SDB rule, or transform them:

  • It's proactive. A HOWTO is something new we want to do with our openSUSE system, not about an existing problem we want to fix. That is for an SDB.
  • Be more verbose, explain things if you want.
  • No easy rule. Keep in mind that if you describe things easy you will probably help more users.
  • Add the Category link to the Category:SDB:HOWTOs page.

FAQ

From the wikipedia definition: "FAQ is an initialism for "Frequently Asked Question(s)". The term refers to listed questions and answers, all supposed to be frequently asked in some context, and pertaining to a particular topic."

  • Make it short
  • Think about what really are frequently asked questions
  • Don't post FAQs from other places, link it and let it live upstream.
  • Use FAQ: name space


Misc

If you are not sure in which category your document is/will be:

  • Ask on the opensuse-wiki mailinglist.
  • Write it without a namespace/prefix (pages can be moved if necessary).
  • Don't be afraid of these rules, just write.
  • At openSUSE we are friendly people.
  • If article was moved or changed it is done with good intention.
  • If you disagree tell other editor your point of view on Discussion page.

Sdb-howto-faq-diagram-0.2.jpg