MediaWiki/Checkliste: Unterschied zwischen den Versionen

Aktuelle Version vom 12. November 2024, 18:48 Uhr

MediaWiki/Checkliste - Verbesserungsmöglichkeiten für Wiki-Artikel finden

Beschreibung

Ziele

Wiki-Artikel sollen als Grundlage für eine Präsentation dienen können

Informationsentnahme erleichtern

Kurze Text
Klare Gliederung
Eindeutige Formatierung

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)

Rechtschreibung, Grammatik und Interpunktion

Fehlerfreies Deutsch

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.

Kategorien

Alle Wiki-Seiten MÜSSEN passend kategorisiert werden.

Quellenangaben und Links

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

Aufruf

Es SOLLTE Wiki-Syntax verwendet werden, HTML-Syntax SOLLTE vermieden werden
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

Prüfungsfragen

Fortschritt

In den Klammern bitte den Fortschritt angegeben.

Rechtschreibung (0%)
Einführung hinzufügen (0%)
Gliederung (0%)
Formatierung (0%)
Wiki-Syntax verbessern (0%)
Texte in Stichpunkte umwandeln (0%)
Beispiele (0%)
1. Wichtige Anwendungsfälle (0%)
2. Bildschirmausgaben als Text, nicht als Grafik (0%)
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%)
Visualisierung (0%)
1. Komplexe Zusammenhänge visualisieren (0%)
2. Diagramme im SVG-Format einbinden (0%)
Übersetzen (0%)
Kategorisierung (0%)

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.

Anhang

Siehe auch

MediaWiki/Artikel/Erstellen

Links

Weblinks

@@ Zeile 1: / Zeile 1: @@
-==Checkliste:Ticket==
+'''MediaWiki/Checkliste''' - Verbesserungsmöglichkeiten für Wiki-Artikel finden
-Diese Seite dient dazu, Regeln einzuhalten, um ein gepflegtes Ticketsystem aufzubauen, als auch produktiv zusammenzuarbeiten. Sie dient auch als Checkliste, bei der Fehleranalyse, um Gründe aufzulisten, warum ein Arbeitspaket(AP) zurückgeschickt wurde.
+== Beschreibung ==
+; Ziele
+Wiki-Artikel sollen als Grundlage für eine Präsentation dienen können
-[[Datei:arbeitspaket.png|thumb|275px|right]]
+; Informationsentnahme erleichtern
-===Ticket===
+* Kurze Text
-#Name des Arbeitspakets kurz halten.
+* Klare Gliederung
-#In der Beschreibung die Ziele des Arbeitspakets angeben
+* Eindeutige Formatierung
-#Ergebnisse in der Beschreibung verlinken.
-#Zuständigkeit und Verantwortung eingeben.
-===Zeit===
+== Qualitätskriterien ==
-#Zeitabschätzungen nach eigenem Willen und Leistungsansprüchen anpassen. (So realistisch wie möglich bleiben!)
+===Inhalt===
-#Enddatum angeben
+* Inhalte müssen fachlich korrekt sein
-#Priorität setzen
+* Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
-===Zuständigkeiten abgeben===
+=== Rechtschreibung, Grammatik und Interpunktion ===
-[[Datei:arbeitspaket_2.png|thumb|500px|right]]
+* Fehlerfreies Deutsch
-#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===
+===Text & Gliederung===
-#APs hierarchisch untergliedern
+* Texte in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
-#Fortschritt angeben
+* Keine Nummerierung in Überschriften
-#Status ändern auf "In Progress" wenn dieses AP bearbeitet wird.
+* In Stichpunkten das Wichtigste über ein Thema schreiben.
-#'''Warnung:''' Das Setzen auf "Done" ist '''nur''' der Projektleitung vorbehalten, siehe 3.1.
+* Formatierungen: So viel wie nötig, so wenig wie möglich.
-===Kommentare===
+===Visualisierungen & Bilder===
-Dies sind Standardkommentare, die genutzt werden sollen, wenn ihr etwas zu bemängeln habt und die APs überweist.
+* Farbige Markierungen
-{| class="wikitable"
+** angeben, wofür die Farbe steht
-|-
+* Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
-! 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==
+=== Kategorien ===
+* Alle Wiki-Seiten MÜSSEN passend kategorisiert werden.
-=== Inhalt ===
+===Quellenangaben und Links===
-# Inhalte müssen fachlich korrekt sein
+* Inhalte MÜSSEN durch Quellen belegt werden
-# Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
+** Gesamte URL
-# Prüfungsfragen eingeben
+**
+* Externe und interne Links numerisch auflisten.
-=== Rechtschreibung, Grammatik und Interpunktion ===
+=== Aufruf ===
-# Der Text muss in fehlerfreiem Deutsch geschrieben werden.
+* Es SOLLTE Wiki-Syntax verwendet werden, HTML-Syntax SOLLTE vermieden werden
-# Englische Wörter oder Fachbegriffe bitte korrekt angeben.
+* Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
+* <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!)
+* Dateien bitte ''kursiv'' markieren, nicht in Code-Format.
+* Überschriften sind mit Gleichheitszeichen zu setzen, nicht mit Apostrophen
+* Überschrift-Ebenen beachten
+* Aufzählungen einheitlich halten
-=== Text & Gliederung ===
+=== Prüfungsfragen ===
-#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 ===
+== Fortschritt ==
-#Nur Bilder auf eine Seite platzieren, die zum Thema passen.
+In den Klammern bitte den Fortschritt angegeben.
-#Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
+# 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%)
-=== Quellenangaben ===
+== Kritik/Anregungen/Verbesserungsvorschläge ==
-#Alle Inhalte müssen durch eine Quelle angegeben werden.
+* Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
-#Fehlende Quellenangaben werden nicht toleriert in der Wiki.
+* Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
-#Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
+* Wer meint fertig zu sein; im OP melden, Link einfügen.
-=== Links ===
+<noinclude>
-#Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
-#Wiki-Seiten bitte kategorisieren.
-=== Kommentare ===
+== Anhang ==
-Die Kommentare bitte in OpenProject und in die Diskussionsseite der entsprechenden Wiki-Seite eintragen, wenn ihr die Zuständigkeit abgegeben wollt.
+=== Siehe auch ===
-{| class="wikitable"
+* [[MediaWiki/Artikel/Erstellen]]
-|-
+----
-! Fehler !! Kommentar
+{{Special:PrefixIndex/MediaWiki/}}
-|-
-| 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"
-|}
-=== Kritik/Anregungen/Verbesserungsvorschläge ===
+==== Links ====
-*Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
+===== Weblinks =====
-*Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
-*Wer meint fertig zu sein; im OP melden, Link einfügen.
-[[Category:Projektmanagement]]
+[[Kategorie:MediaWiki/Anleitung]]
-[[Category:Openproject]]
+</noinclude>
-[[Category:Mediawiki]]