Dieses Dokument enthält Richtlinien zum Schreiben eines Wiki-Artikels und für die Arbeiten, die nötig sind, die SliTaz-Dokumentation aktuell zu halten.

1. Zentralisierung aller Dokumentationen unter http://doc.slitaz.org
2. Vollständige Verlagerung der Handbücher und des Kochbuchs (des Konzeptbuches, wenn möglich)
3. Übersetzung der Handbücher und des Kochbuchs
4. Die Wiki-Artikel der Laboratorien verknüpfen oder übersetzen
5. Überprüfen und Aktualisieren der Handbücher und des Kochbuchs der Version 3.0
6. Neue Anleitungen erstellen. Eine Wunschliste der Anleitungen wurde auf der (englischsprachigen) Seite guides als Vorschlag angelegt
7. Überprüfen und Aktualisieren der vorhandenen Anleitungen

• Hinzufügen: Dem Wiki können nach Belieben Seiten hinzugefügt werden
  • Namensbereiche und Hierarchie der Dokumentation : Die Hierarchie der Dokumentation wurde für die englische Sprache festgelegt. Bitte behalten Sie diese bei, wenn Sie neue Seiten erstellen. Zum Beispiel:
    • de:handbook:start: deutsche Handbuch-Eingangsseite
    • de:handbook:desktop: Auf die Seite desktop wird von der Handbuch-Eingangsseite verwiesen. Alle deutschen Handbuch-Seiten sollten sich in dem Namensbereich de:handbook: befinden.
    • de:guides:faq: Alle deutschen Seiten mit Anleitungen sollten sich in dem Namensbereich de:guides: befinden. Ein Seite für eine oft gestellte Frage kann einfach mit [[faq | FAQ]] im Namensbereich de:guides:faq eingerichtet werden.
    • Index: Aus den Verknüpfungen ist die hierarchische Struktur erkennbar
  • Bilder einfügen : Mit einer Schaltfläche der Werkzeugleiste können Bilder in einen Namensbereich eingefügt werden
• Löschen: Wenn der gesamte Inhalt einer Seite entfernt wird, wird die Seite gelöscht
• Qualitätsbericht: Jede Seite sollte einen Qualitätsbericht enthalten. Ein Beispiel befindet sich am Ende dieser Seite. Ein Qualitätsbericht ist einfach eine Wiki-Tabelle. Diese Tabelle darf geändert und um weitere Zeilen ergänzt werden. Sie darf in die jeweilige Sprache übersetzt werden. Sie können den Qualitätsbericht dieser Seite in jede andere Wiki-Seite kopieren und entsprechend modifizieren

Es gibt mehrere Schemata, um ein einheitliches Layout zu erreichen:

Dieses Schema ist auf die Seite Oft gestellte Fragen anzuwenden.

1. Fehlermeldung - Titel der einzelnen Frage mit einer verständlichen Beschreibung, normalerweise der angezeigten Fehlermeldung.
2. Symptome - eine kurze Beschreibung dessen was passiert, wenn das Problem auftritt. Es können auch mehrere Symptome erscheinen. Achten Sie auf korrekte Formatierung von Bildschirmmeldungen, Tastenbetätigungen usw., damit Google hoffentlich gute Suchergebnisse liefern kann.
3. Erklärung - eine nicht zu technische Erklärung der Fehlermeldung. Die Anwender sollen damit das Problem auf höherer Ebene verstehen können und wie es behoben werden kann.
4. Lösung - technische Beschreibung, wie das Problem gelöst werden kann. Diese sollte nicht nur eine Liste von Kommandos enthalten, sondern auch eine kurze Beschreibung der einzelnen Schritte; dem Anwender muss klar werden, was er warum zu tun hat. Problemlösungen können sich je nach Umgebung unterscheiden – verwenden Sie Aufzählungspunkte o.ä. um dies darzustellen.

Diese befinden Sich im Namensraum <lang>:guides:<thema>. Darin wird beschrieben, wie etwas in Gang gebracht werden kann.

1. Einleitung - Zusammenfassung des Artikels
2. mit grafischer Oberfläche
   • Anleitungen - Wie grafische Werkzeuge angewendet werden können, wenn es welche gibt
   • Bildschirmfotos - Ein Bild sagt mehr als tausend Worte
3. mit Kommando-Eingaben
   • Installation - Beschreiben Sie die benötigten Pakete und wie sie installiert werden
   • Konfiguration - Erklären Sie, wie Konfigurationsdateien modifiziert werden müssen, damit die Pakete richtig funktionieren
   • Zusammenfassung - Wenn möglich, fassen Sie alle Kommandos in einer einzigen Kommandoprozedur zusammen
4. Beispiele und Hinweise - Fügen Sie einige Beispiele und anspruchsvollere Hinweise hinzu
5. FAQ/Problembehebung - Einige Anleitungen zur Selbsthilfe oder ein Unterabschnitt über Probleme, ihre Symptome, ihre Lösungen und Anmerkungen oder eine Verknüpfung mit einem Forum-Beitrag, eine Verknüpfung mit FAQ, wenn dort beantwortet
6. Verweise - Verweise auf gutes, über das Internet zugängliches Informationsmaterial. Wenn es keines gibt, könnten Sie versuchen, es anzufordern!

Diese befinden Sich im Namensraum <lang>:handbook:<thema>. Darin wird beschrieben, was SliTaz für ein bestimmtes Thema anbieten kann. Dies sind Übersichts- und Beschreibungsartikel, keine Anleitungen, obwohl sie auch in (sehr) wenigen Schritten beschreiben können, wie etwas in Gang gebracht werden kann.

1. Klappentext - beschreibt den Inhalt der Seite bezüglich des Anwendungsbereichs.
2. Thema - was der Anwender tun möchte, z.B. Bildbearbeitung oder grafische Oberflächen
3. Textkörper - ein Überblick über das Thema, mit Verknüpfungen mit den entsprechenden Anleitungen oder externen Webseiten.
4. Hinweise (optional) - alle Probleme, die auftreten können. Verknüpfung mit FAQ, wenn dort beantwortet, mit Forum-Beiträgen, mit Webseiten, die eine gute Problemlösung zeigen usw.

Verwenden Sie bitte die richtigen Formatierungen, woimmer möglich. Es verbessert die Lesbarkeit und verhindert oft Zweideutigkeiten zwischen Kommandoeingaben und Kommandoausgaben usw.

• Lernen Sie die Wiki-Syntax hier kennen. Zum Ausprobieren steht Ihnen die Spielwiese zur Verfügung.

Qualitätsbericht
Qualität	gut
Überprüfung	muss überprüft werden
Priorität	mittel
Probleme	eine Verknüpfung zum Forum einfügen
	ODER eine Verknüpfung zu den Laboratorien einfügen
Was verbessert werden kann	kurze Vorschläge
	Neue Richtlinien zum Testen von Paketen sind hier
	Neue Zeilen wie diese einfügen