QM-Checkliste

Aus ITWiki
Zur Navigation springen Zur Suche springen

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

1 Ziele

Mit den Wiki-Artikeln sollen Folgende Ziele verfolgt werden

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

2 Fortschritt

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

3 Qualitätskriterien - Formale und inhaltliche Kriterien

3.1 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.

3.2 Rechtschreibung, Grammatik und Interpunktion

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

3.3 Text & Gliederung

  • Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
  • Keine Nummerierung in Überschriften. (Übernimmt die Wiki!)
  • 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.

3.4 Visualisierungen & Bilder

  • Bei farbigen Markierungen bitte angeben, wofür die Farbe steht.
  • 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.

3.5 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.

4 Syntax

4.1 HTML

  • Es darf nur Wiki-Syntax verwendet werden (Keine HTML-Syntax verwenden!)
  • HTML-Tags sind nur bei Anforderungen des Projektleiters erwünscht
  • Ausnahme bei HTML-Codes: Einsetzen der Klappfenster (Einzusetzen bei Prüfungsfragen!)

4.2 Wiki-Syntax

  • 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

5 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.

6 Links

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


503