SliTaz-Dokumentationsrichtlinien
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.
Sommer der Dokumentation
-
Vollständige Verlagerung der Handbücher und des Kochbuchs (des Konzeptbuches, wenn möglich)
Übersetzung der Handbücher und des Kochbuchs
Die Wiki-Artikel der
Laboratorien verknüpfen oder übersetzen
Überprüfen und Aktualisieren der Handbücher und des Kochbuchs der Version 3.0
Neue Anleitungen erstellen. Eine Wunschliste der Anleitungen wurde auf der (englischsprachigen) Seite
guides als Vorschlag angelegt
Überprüfen und Aktualisieren der vorhandenen Anleitungen
Allgemeine Anweisungen
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
Layout der Seiten
Es gibt mehrere Schemata, um ein einheitliches Layout zu erreichen:
FAQ
Dieses Schema ist auf die Seite Oft gestellte Fragen anzuwenden.
Fehlermeldung - Titel der einzelnen Frage mit einer verständlichen Beschreibung, normalerweise der angezeigten Fehlermeldung.
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.
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.
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.
Anleitungen
Diese befinden Sich im Namensraum <lang>:guides:<thema>. Darin wird beschrieben, wie etwas in Gang gebracht werden kann.
Einleitung - Zusammenfassung des Artikels
mit grafischer Oberfläche
Anleitungen - Wie grafische Werkzeuge angewendet werden können, wenn es welche gibt
Bildschirmfotos - Ein Bild sagt mehr als tausend Worte
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
Beispiele und Hinweise - Fügen Sie einige Beispiele und anspruchsvollere Hinweise hinzu
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
Verweise - Verweise auf gutes, über das Internet zugängliches Informationsmaterial. Wenn es keines gibt, könnten Sie versuchen, es anzufordern!
Handbuch
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.
Klappentext - beschreibt den Inhalt der Seite bezüglich des Anwendungsbereichs.
Thema - was der Anwender tun möchte, z.B. Bildbearbeitung oder grafische Oberflächen
Textkörper - ein Überblick über das Thema, mit Verknüpfungen mit den entsprechenden Anleitungen oder externen Webseiten.
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.