MediaWiki/Checkliste: Unterschied zwischen den Versionen
K Dirkwagner verschob die Seite QM-Checkliste nach ITWiki:QM-Checkliste, ohne dabei eine Weiterleitung anzulegen |
|
(kein Unterschied)
|
Version vom 20. September 2020, 10:10 Uhr
Ziele
- Grundlage für eine Präsentation
- Informationsentnahme erleichtern
Fortschritt
- Rechtschreibung (0%)
- Einführung hinzufügen (0%)
- Gliederung (0%)
- Formatierung (0%)
- Wiki-Syntax verbessern (0%)
- Texte in Stichpunkte umwandeln (0%)
- Beispiele (0%)
- Wichtige Anwendungsfälle (0%)
- Bildschirmausgaben als Text, nicht als Grafik (0%)
- Links (0%)
- Intern (andere Artikel in wiki.itw-berlin.net) (0%)
- Extern (0%)
- Quellen (0%)
- Primärquelle angeben (0%)
- Projekt-Homepage (0%)
- Visualisierung (0%)
- Komplexe Zusammenhänge visualisieren (0%)
- Diagramme im SVG-Format einbinden (0%)
- Übersetzen (0%)
- Kategorisierung (0%)
- Mit Prozentangaben in Klammern wird der Fortschritt angegeben.
Qualitätskriterien
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
- Keine Satzzeichen in Überschriften
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.
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.
Quellenangaben und Links
- Inhalte MÜSSEN durch Quellen belegt werden
- Gesamte URL
- Externe und interne Links numerisch auflisten.
- Wiki-Seiten bitte kategorisieren.
Syntax
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!)
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
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.