Howto
Was ist ein Howto?¶
Ein Howto ist eine einfache Schritt-für-Schritt-Anleitung, welche von Nutzern für Nutzer erstellt wurde. Howtos können z.B. zur Unterstützung im Support verwendet werden, um schnelle Problemlösungen bereitzustellen oder auch z.B. komplexere Installationsszenarien von Programmen und Diensten Schritt für Schritt beschrieben . Sie sind daher nicht Teil des hiesigen Wikis, in dem für (neue) Artikel umfassendere Ansprüche gelten.
Achtung!
Bei Problemen mit einem Howto melde dies bitte in der dazugehörigen Diskussion und wende dich bitte zusätzlich an den Verfasser des Howtos. Die Anwendung erfolgt wie üblich auf eigene Gefahr.
Vorhandene Howtos¶
Vorhandene Howtos sind über ihre Schlagwort-Kennzeichnung (Tags) zu finden: Liste fertiger Howtos
Howto erstellen¶
Im Vergleich zu einem Wikiartikel muss ein Autor bei der Erstellung eines Howtos deutlich weniger Punkte beachten.
Aufbau eines Howto¶
Ein Howto sollte aufgrund einer besseren Verständlichkeit die folgenden Gliederung benutzen:
Howto Markierung – Angabe, wer das Howto erstellt hat
getestet mit - es wird der selbe getestet-Block verwendet wie bei Wikiartikeln
Einleitung – Hier wird das Problem beschrieben, welches mithilfe des Howtos gelöst werden soll.
Anleitung – Die einzelnen Schritte, wie das Problem gelöst werden kann.
Linksammlung – Links zum zugehörigen Wikiartikel, falls es einen gibt, und/oder zu weiterführenden Internetseiten.
Tag: Howto - jedes Howto muss den den Tag "Howto" am Ende enthalten
Gestaltung des Howtos¶
Da es sich bei ubuntuusers.de um ein deutschsprachiges Portal handelt, sind Howtos in korrekter deutscher Sprache zu verfassen.
Direkte Anrede (z.B. „Danach machst du ...“) ist zu vermeiden. Stattdessen soll das neutrale „man“ (z.B. „Danach macht man ...“) verwendet werden, da so die Sachlichkeit des Artikels besser zur Geltung kommt.
Auf umgangssprachliche Ausdrücke (z.B. „Jetzt läuft das System total rund und alles ist easy going.“) sollte verzichtet und stattdessen eine sachliche Formulierung gewählt werden (z.B. „Jetzt läuft das System völlig problemlos.“). Dies erhöht die Lesbarkeit eines Howtos deutlich.
Die vollständigen Syntaxregeln des Wikis müssen nicht beachtet werden, können aber. Es macht das Lesen oft einfacher, wenn man zumindest einige Formatierungselemente nutzt. Besonders die Verwendung von Codeboxen zur korrekten Formatierung von Codebeispielen und -ausgaben wird empfohlen.
Formatierungselemente sollen innerhalb eines Howtos einheitlich verwendet werden. Also z.B. nicht Dateinamen einmal fett und an anderer Stelle kursiv formatieren, sondern einheitlich fett oder kursiv.
Die Verwendung von Smilies und Emojis ist in Howtos nicht gestattet.
Zusätzlich sei noch auf den Abschnitt Nicht gestattete Inhalte weiter unten verwiesen, der einige häufige Fehler bei der Erstellung eines Howtos aufführt.
Lizenzbedingungen¶
Mit dem Speichern des Howtos erklärst du dich mit den Portalregeln und der Veröffentlichung deines Howtos unter den aktuell gültigen Lizenzbedingungen des Wikis einverstanden.
Du bestätigst mit dem Speichern außerdem, dass du das Howto selbst erstellt hast und es nicht von einer anderen Quelle kopiert hast.
Das Wikiteam behält sich die Nicht-Veröffentlichung der Howtos vor, z.B. dann, wenn die oben aufgeführten, minimalen Gestaltungsregeln nicht eingehalten werden. Ebenso behält sich das Wikiteam das Entfernen von Howtos vor, z.B. wenn sich in der zugehörigen Diskussion herausstellt, dass der Inhalt fehlerhaft oder gar schädlich ist.
Howto veröffentlichen¶
Möchtest du ein Howto veröffentlichen, dann eröffne mit einem Klick auf „Diskussion“ (rechts oben in der Menüleiste) ein neues Thema und kündige an, dass dein Howto fertig ist. Das Wikiteam überprüft daraufhin, ob die wenigen formalen Punkte erfüllt sind. Eine inhaltliche Prüfung findet nicht statt. Nach einer erfolgreichen Prüfung verschiebt das Wikiteam das Howto in die Howto-Sammlung und ergänzt einen Eintrag auf dieser Übersichtseite.
Des Weiteren können, Howtos vom Wiki aus an passenden Stellen verlinkt werden. Der Link auf das Howto kann in einem passendem Wikiartikel im Abschnitt "Links" aufgenommen werden.
Howto anlegen¶
Howtos müssen über die Seite Wikiartikel_anlegen erstellt werden. Bitte dem gewünschten Artikelnamen ein Howto/ voranstellen.
Ein neues Howto wird dann in der Baustelle angelegt. Vorlage/Howto zeigt die Struktur und die wichtigsten Elemente.
Bearbeiten von Howtos¶
Der Nutzer, der das Howto erstellt hat, sollte dieses natürlich auch langfristig pflegen und aktuell halten. Grundsätzlich dürfen Howtos aber, wie Wiki-Artikel auch, von jedem angemeldeten Benutzer bearbeitet, aktualisiert und erweitert werden. Nach dem Überarbeiten eines Howtos muss dieses erneut getestet werden, um im Howto-Bereich zu verbleiben.
Archivierung von Howtos¶
Howtos werden automatisch vom Wikiteam als „Veraltet“ markiert, wenn
jede Ubuntuversion, für die das Howto getestet ist, das Supportende erreicht hat
in der Diskussion ein Fehler gemeldet wurde und dieser nicht innerhalb von zwei Wochen korrigiert wird.
Veraltete Howtos werden nach weiteren zwei Monaten ins Archiv verschoben. Wird das Howto innerhalb dieser zwei Monate erfolgreich getestet, dann verbleibt das Howto in der Howto-Sammlung und der Hinweis „Veraltet“ wird entfernt.
Nicht gestattete Inhalte¶
Kurzadressen (URL-Shortener) sind nicht gestattet. Das Gleiche betrifft auch Links zu kommerziellen Online-Shops und ähnlichen Seiten („Schleichwerbung“).
Weder das Wiki noch ubuntuusers.de sind ein Downloadportal. Sollen im Rahmen eines Howtos Dateien angeboten werden, sind diese auf externen Speicherorten (Cloud-Dienste, eigene Server usw.) abzulegen. Die Nutzung erfolgt dann über die Verlinkung externer Inhalte.
Links¶
Baustelle/Howto - Übersicht der Howto Baustellen
Neue Howtos - Übersicht neu veröffentlichter und überarbeiteter Howtos nach Datum