MediaWiki/Checkliste

Aus Foxwiki

Dies ist eine Checkliste zum Überprüfen der Wiki-Seiten. Beachtet, dass die Wiki-Seiten als Grundlage für Präsentationen und zur Informationsentnahme für andere Teilnehmer dienen sollen

Zusammenfassung

Ziele

  1. Grundlage für Präsentation
  2. Informationsentnahme erleichtern

Verbesserungen

  1. OP-Ticket-Link angeben
  2. Rechtschreibung
  3. Einführung hinzufügen
  4. Gliederung
  5. Formatierung
  6. Wiki-Syntax verbessern
  7. Texte in Stichpunkte umwandeln
  8. Beispiele
    1. Alle wichtigen Anwendungsfälle
    2. Bildschirmausgaben als Text, nicht als Grafik
  9. Links
    1. Intern (andere Artikel in wiki.itw-berlin.net)
    2. Extern
    3. Quellen
      1. Primärquelle angeben
      2. Projekt-Homepage
  10. Visualisierung
    1. Komplexe Zusammenhänge visualisieren
    2. Diagramme im SVG-Format einbinden
  11. Übersetzen
  12. Kategorisierung

  • Prozentzeichen hinter jedem Punkt zeigen an, wie viel in dem Bereich gemacht werden muss
  • Bei 100% ist das Kriterium erfüllt.

Qualitätskriterien - Formale und inhaltliche Kriterien

Inhalt

  • Inhalte müssen fachlich korrekt sein
  • Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
  • Prüfungsfragen eingeben
  • Keinen Hinweis schreiben, dass ein Artikel bearbeitet werden muss.

Rechtschreibung, Grammatik und Interpunktion

  • Der Text muss in fehlerfreiem Deutsch geschrieben werden.
  • Englische Wörter oder Fachbegriffe bitte korrekt angeben.
  • Keine doppelten Satzzeichen

Text & Gliederung

  • Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
  • Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
  • Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
  • Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.

Bilder

  • Nur Bilder auf eine Seite platzieren, die zum Thema passen.
  • Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
  • Bilder bitte am rechten Rand der Wiki-Seite platzieren.

Quellenangaben und Links

  • Alle Inhalte müssen durch eine Quelle angegeben werden.
  • Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
  • Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
  • Externe und interne Links numerisch auflisten.
  • Wiki-Seiten bitte kategorisieren.

Syntax

  • Es darf nur Wiki-Syntax verwendet werden (Keine HTML-Syntax verwenden!)
  • Ausnahme bei HTML-Codes: Einsetzen der Klappfenster (Einzusetzen bei Prüfungsfragen!)
  • Entweder die Leerzeile oder den <code>-Block verwenden, nicht beides.
  • <br> im Code ist nicht notwendig.
  • Beim allgemeinen Code-Syntax darauf achten, welche Parameter nötig und welche Optional sind, optionale Parameter bitte mit [] markieren. (Schaut in die man-Pages!)
  • Dateien bitte kursiv markieren, nicht in Code-Format.
  • Überschriften sind mit Gleichheitszeichen zu setzen, nicht mit Apostrophen
  • Überschrift-Ebenen beachten
  • Aufzählungen einheitlich halten

Kritik/Anregungen/Verbesserungsvorschläge

  • Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
  • Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
  • Wer meint fertig zu sein; im OP melden, Link einfügen.

Links

  1. Wiki-Artikel erstellen
  2. https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103


503