MediaWiki/Checkliste
Dies ist eine Checkliste zum Überprüfen der Tickets und der Wiki-Seiten.
Checkliste:Ticket
Ticket
- Name des Arbeitspakets kurz halten.
- Aufbau beachten in der Beschreibung(Ziele;Bezug;Quellen).
- In der Beschreibung die Ziele des Arbeitspakets angeben.
- Ergebnisse in der Beschreibung verlinken.
- Zuständigkeit und Verantwortung eingeben.
Zeit
- Zeitabschätzungen nach eigenem Willen und Leistungsansprüchen anpassen. (So realistisch wie möglich bleiben!)
- Enddatum angeben
- Priorität setzen
Zuständigkeiten abgeben
- Wer mit der Aufgabe fertig ist oder Probleme auftreten, auf "Zugewiesen an" klicken und an den zuständigen Teamleiter (od. Projektleiter) senden.
- Bei der Überweisung ein Kommentar abgeben, warum man es abgegeben hat (bspw. Aufgabe fertig, Problem, Unklarheiten).
- Bitte gründlich und klar formulieren, unkommentierte Überweisungen werden zurückgeschickt.
Pflege eines AP
- APs hierarchisch untergliedern
- Fortschritt angeben
- Status ändern auf "In Progress" wenn dieses AP bearbeitet wird.
- Warnung: Das Setzen auf "Done" ist nur der Projektleitung vorbehalten, siehe 3.1.
Kommentare
Dies sind Standardkommentare, die genutzt werden sollen, wenn ihr etwas zu bemängeln habt und die APs überweist.
Fehlertyp | Kommentar |
---|---|
1.2 | "Ungenaue Zielangabe" |
1.2 | "Fehlende Zielangabe" |
1.3 | "Bitte Link zum Wiki-Artikel einfügen" |
1.4 | "Fehlende Zuständigkeit" |
1.4 | "Fehlender Verantwortlicher" |
2.1 | "Fehlende Zeiteinschätzungen" |
2.2 | "Enddatum eintragen" |
2.3 | "Priorität nicht gesetzt" |
3.2 | "Bitte keine Zuweisungen ohne Kommentar" |
4.1 | "AP ist nicht hierarchisch eingegliedert" |
4.2 | "Fortschritt angeben" |
4.3 | "Status ist falsch" |
4.4 | "Tasks nicht auf Done setzen" |
Qualitätskriterien - Formale und inhaltliche Kriterien
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
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.
Kommentare
Die Kommentare bitte in OpenProject und in die Diskussionsseite der entsprechenden Wiki-Seite eintragen, wenn ihr die Zuständigkeit abgegeben wollt.
Fehler | Kommentar |
---|---|
1.1 | "Fachlich falscher Text" |
1.2 | "Code besser kennzeichnen" |
1.3 | "Gibt es Prüfungsfragen?" |
2.1 | "Rechtschreibung falsch" |
2.2 | "Falsch geschriebener Fachbegriff" |
3.1 | "Keine oder ungünstige Gliederung" |
3.2 | "Zu langer Text" |
3.3 | "Zu viele Formatierungen" |
4.1 | "Unpassendes Bild" |
5.1 | "Fehlende Quellenangaben" |
6.1 | "Links einsetzen" |
6.2 | "Fehlende Kategorisierung" |
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
- Den Wiki-Artikel am Ende mit 4 Tilden(~) signieren
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.