ITWiki:QM-Checkliste

Aus ITWiki
Zur Navigation springen Zur Suche springen

Die QM-Checkliste soll dabei helfen, Verbesserungsmöglichkeiten für Wiki-Artikel zu finden.

1 Ziele

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

2 Qualitätskriterien

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

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

2.3 Text & Gliederung

  • Texte in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
  • Keine Nummerierung in Überschriften
  • In Stichpunkten das Wichtigste über ein Thema schreiben.
  • Formatierungen: So viel wie nötig, so wenig wie möglich.

2.4 Visualisierungen & Bilder

  • Farbige Markierungen
    • angeben, wofür die Farbe steht
  • Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
  • Bilder bitte am rechten Rand der Wiki-Seite platzieren.

2.5 Kategorien

  • Alle Wiki-Seiten MÜSSEN passend kategorisiert werden.

2.6 Quellenangaben und Links

  • Inhalte MÜSSEN durch Quellen belegt werden
    • Gesamte URL
  • Externe und interne Links numerisch auflisten.

3 Syntax

3.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!)

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

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

5 Fortschritt

In den Klammern bitte den Fortschritt angegeben.

  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%)

6 Links

6.1 Interne Links

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