Wiki-Guideline

Aus Handbuch - Die Neue Welt
Version vom 1. Januar 2020, 17:32 Uhr von Aurion (Diskussion | Beiträge) (→‎Best Practices)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

Übersicht

Diese Seite beschreibt Best Practices, die beim Erstellen von Wiki-Seiten beachtet werden sollen:

Best Practices

Allgemein

  • Eine Seite muss nicht gleich perfekt sein. Wenn jemand etwas Wichtiges beschreiben will, kann er die Seite anlegen und einfach mal anfangen. Verbessern kann man sie immer noch.
  • Andererseits muss auch aufgeräumt werden. Veralteter oder nicht benötigter Inhalt kann auch mal gelöscht werden. Seite mit wenigem, aber nützlichem Inhalt können in andere Seiten integriert werden. Ziel ist es, das Wiki stehts aktuell und gut strukturiert zu behalten.
  • Bevor größere und grundsätzliche Änderungen an Wiki-Seiten gemacht werden, macht es Sinn, diese Änderungen auf einer Test-Seite auszuprobieren und im Zweifel zur Abstimmung zu geben, bevor die eigentliche Seite geändert wird.
  • Für technische Tests (neue Erweiterung etc.) kann bzw. sollte erst einmal das Testwiki verwendet werden.
  • Redundanz soll vermieden werden:
    • Als Beispiel enthalten die Rassen-Seiten der Homepage RP-Hintergründe. Das Wiki wiederholt diese nicht, sondern beinhaltet vor allem technische Details, wie spielbare Klassen.
    • Wenn ein Inhalt im Wiki mehrmals gebraucht wird, sollte er über Wiki-Techniken eingebunden werden. Beispiele dafür sind die Seiten Rassen und Klassen, die einzeln verwendet werden, aber auch in der Hauptseite inkludiert sind.

Kategorien

  • Kategorien helfen bei der Gruppierung von Seiten. Beispiel: Kategorie:Fähigkeit.
  • Kategorien sollen in Einzahl (Fähigkeit, statt Fähigkeiten) benannt sein.
  • Kategorien sollten vom Allgemeinsten zum Spezifischsten angeordnet sein.
  • Auch Bilder bekommen Kategorien

Bilder

  • Konsistente Benennung hilft beim Auffinden und Zuordnen.
  • Bilder sollten möglichst genau nach dem benannt werden, was sie darstellen. Statt Ddn.png sollte es z.B. besser "Gildenabzeichen DdN.png" oder gar "Gildenabzeichen Diener des Namenlosen.png" heißen (vgl. Gildenabzeichen Fluch der Ratten)

Formatierung

  • Seiten sollen möglichst einheitlich formatiert werden.
  • Überschriften-Hierarchie beachten: Unter einer H1 kommt erst ein H2 Heading und nicht direkt H3
  • Wiki-Formattierung ist bevorzugt zu verwenden. Statt H1, H2 etc. lieber mit = bzw. == etc.
  • Formatierungen wie Bold/Italic nicht in Überschriften verwenden. Das Aussehen von Überschriften wird von CSS-Dateien definiert.

Vorbereitung DNW2.0

  • Seiten die speziell für DNW2.0 angelegt werden, sollen mit der Kategorie DNW2 sowie dem Prefix DNW2 benannt werden. Beispiel DNW2:Druide.