MediaWiki/Checkliste

Dies ist eine Checkliste zum Überprüfen der Wiki-Seiten.

Qualitätskriterien - Formale und inhaltliche Kriterien

Inhalt

1. Inhalte müssen fachlich korrekt sein
2. Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
3. Prüfungsfragen eingeben

Rechtschreibung, Grammatik und Interpunktion

1. Der Text muss in fehlerfreiem Deutsch geschrieben werden.
2. Englische Wörter oder Fachbegriffe bitte korrekt angeben.

Text & Gliederung

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

Bilder

1. Nur Bilder auf eine Seite platzieren, die zum Thema passen.
2. Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.

Quellenangaben

1. Alle Inhalte müssen durch eine Quelle angegeben werden.
2. Fehlende Quellenangaben werden nicht toleriert in der Wiki.
3. Quellen aus Internetseiten bitte mit der gesamten URL verlinken.

Links

1. Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
2. Wiki-Seiten bitte kategorisieren.

Syntax

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

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

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

https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103

503