MediaWiki/Checkliste: Unterschied zwischen den Versionen

Version vom 28. April 2020, 12:42 Uhr

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

Qualitätskriterien - Formale und inhaltliche Kriterien

Inhalt

Inhalte müssen fachlich korrekt sein
Nur in kurzen Stichpunkten schreiben
Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
Prüfungsfragen eingeben

Rechtschreibung, Grammatik und Interpunktion

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

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.

Quellenangaben

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

Links

Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
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

Zusammenfassung

Ziele

Grundlage für Präsentation
Informationsentnahme erleichtern

Verbesserungen

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

@@ Zeile 4: / Zeile 4: @@
 === Inhalt ===
-# Inhalte müssen fachlich korrekt sein
+* Inhalte müssen fachlich korrekt sein
-# Nur in kurzen Stichpunkten schreiben
+* Nur in kurzen Stichpunkten schreiben
-# Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
+* Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
-# Prüfungsfragen eingeben
+* Prüfungsfragen eingeben
 === Rechtschreibung, Grammatik und Interpunktion ===
-# Der Text muss in fehlerfreiem Deutsch geschrieben werden.
+* Der Text muss in fehlerfreiem Deutsch geschrieben werden.
-# Englische Wörter oder Fachbegriffe bitte korrekt angeben.
+* Englische Wörter oder Fachbegriffe bitte korrekt angeben.
 === Text & Gliederung ===
-#Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
+* Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
-#Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
+* Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
-#Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
+* 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.
+* Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.
 === Bilder ===
-#Nur Bilder auf eine Seite platzieren, die zum Thema passen.
+* Nur Bilder auf eine Seite platzieren, die zum Thema passen.
-#Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
+* Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
 === Quellenangaben ===
-#Alle Inhalte müssen durch eine Quelle angegeben werden.
+* Alle Inhalte müssen durch eine Quelle angegeben werden.
-#Fehlende Quellenangaben werden nicht toleriert in der Wiki.
+* Fehlende Quellenangaben werden nicht toleriert in der Wiki.
-#Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
+* Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
 === Links ===
-#Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
+* Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
-#Wiki-Seiten bitte kategorisieren.
+* Wiki-Seiten bitte kategorisieren.
 ==Syntax==
-#Es darf nur Wiki-Syntax verwendet werden (''Keine HTML-Syntax verwenden!'')
+* Es darf nur Wiki-Syntax verwendet werden (''Keine HTML-Syntax verwenden!'')
-#Ausnahme bei HTML-Codes: Einsetzen der Klappfenster (Einzusetzen bei Prüfungsfragen!)
+* Ausnahme bei HTML-Codes: Einsetzen der Klappfenster (Einzusetzen bei Prüfungsfragen!)
-#Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
+* Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
-#<nowiki><br></nowiki> im Code ist nicht notwendig.
+* <nowiki><br></nowiki> 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!)
+* 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.
+* Dateien bitte ''kursiv'' markieren, nicht in Code-Format.
-#Überschriften sind mit Gleichheitszeichen zu setzen, nicht mit Apostrophen
+* Überschriften sind mit Gleichheitszeichen zu setzen, nicht mit Apostrophen
-#Überschrift-Ebenen beachten
+* Überschrift-Ebenen beachten
-#Aufzählungen einheitlich halten
+* Aufzählungen einheitlich halten
 ==Zusammenfassung==