Mailinglist Archive: opensuse-project (169 mails)

< Previous Next >
[opensuse-project] SDB/Howto/FAQ
  • From: Martin Lasarsch <mlasars@xxxxxxx>
  • Date: Wed, 17 Oct 2007 16:54:53 +0200
  • Message-id: <200710171654.54270.mlasars@xxxxxxx>
Hi

ok, i have still the bug open for a long time, here is my point of view for 
discussion. The wiki makes it possible to clutter a lot of pages over the 
whole wiki, or try to make some kind of order.

- is this point of view valid for most of you?
- do we need the separation?
- what is missing?

* SDB
An SDB article should describe a solution to a problem in a special format. 
- separate namespace: SDB:
- focus should be on beginners, easiest solution first
- no doctoral thesis, short and to the point
- for more information link to howto and/or FAQ
- definition how to write is in the sdb-howto (which is in the SDB, yeah, i 
know ...)

Examples what not to put into the SDB: 
- article about how to install xen
- article describes how to use smart instead of zypper/YaST

Examples which are not SDB articles for me:
Configuring_Evolution_in_openSuSE_10.2
Samba_file_sharing_in_openSUSE_-_breaking_through_the_window
Installing_GRAMPS_in_openSUSE_10.2
(i just picked 3 from the top, great articles, but not SDB)

* Howto
A howto has not the restrictions like an SDB article.
- should have a separate namespace: HOWTO:
- the purpose is not to solve a problem, but this is not mandatory(?)
- it could be detailed like a doctoral thesis, but don't have to
- not mandatory focused on beginners
- imho, and this might be only my opinion, it should still be written as easy 
as possible.
- we already have a launchpage for Howtos

* FAQ
- should have a separate namespace: FAQ:
- short and to the point
- the general FAQ layout should be known, so no more explanation here
- we should have a FAQ launchpage with all FAQs on it

-- 
with kind regards,

Martin Lasarsch, Core Services
SUSE LINUX Products GmbH, Maxfeldstr. 5 90409 Nürnberg
GF: Markus Rex, HRB 16746 (AG Nürnberg)
martin.lasarsch@xxxxxxx - http://www.opensuse.org
---------------------------------------------------------------------
To unsubscribe, e-mail: opensuse-project+unsubscribe@xxxxxxxxxxxx
For additional commands, e-mail: opensuse-project+help@xxxxxxxxxxxx

< Previous Next >