MediaWiki/Checkliste: Unterschied zwischen den Versionen

Aus Foxwiki
Keine Bearbeitungszusammenfassung
K Textersetzung - „== Syntax ==“ durch „== Aufruf ==“
 
(78 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Dies ist eine Checkliste zum Überprüfen der Tickets und der Wiki-Seiten.
'''MediaWiki/Checkliste''' - Verbesserungsmöglichkeiten für Wiki-Artikel finden


==Checkliste:Ticket==
== 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
#Aufbau beachten in der Beschreibung(Ziele;Bezug;Quellen).
* Eindeutige Formatierung
#In der Beschreibung die Ziele des Arbeitspakets angeben.
#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===
[[Datei:arbeitspaket_2.png|thumb|500px|right]]
#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.
{| class="wikitable"
|-
! 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 ===
=== Rechtschreibung, Grammatik und Interpunktion ===
# Der Text muss in fehlerfreiem Deutsch geschrieben werden.
* Fehlerfreies Deutsch
# Englische Wörter oder Fachbegriffe bitte korrekt angeben.


=== Text & Gliederung ===
===Text & Gliederung===
#Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
* Texte in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
#Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
* Keine Nummerierung in Überschriften
#Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
* In Stichpunkten das Wichtigste über ein Thema schreiben.
#Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.
* Formatierungen: So viel wie nötig, so wenig wie möglich.


=== Bilder ===
===Visualisierungen & Bilder===
#Nur Bilder auf eine Seite platzieren, die zum Thema passen.
* Farbige Markierungen
#Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
** angeben, wofür die Farbe steht
* Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.


=== Quellenangaben ===
=== Kategorien ===
#Alle Inhalte müssen durch eine Quelle angegeben werden.
* Alle Wiki-Seiten MÜSSEN passend kategorisiert werden.
#Fehlende Quellenangaben werden nicht toleriert in der Wiki.
#Quellen aus Internetseiten bitte mit der gesamten URL verlinken.


=== Links ===
===Quellenangaben und Links===
#Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
* Inhalte MÜSSEN durch Quellen belegt werden
#Wiki-Seiten bitte kategorisieren.
** Gesamte URL
**
* Externe und interne Links numerisch auflisten.


=== Kommentare ===
=== Aufruf ===
Die Kommentare bitte in OpenProject und in die Diskussionsseite der entsprechenden Wiki-Seite eintragen, wenn ihr die Zuständigkeit abgegeben wollt.
* Es SOLLTE Wiki-Syntax verwendet werden, HTML-Syntax SOLLTE vermieden werden
{| class="wikitable"
* Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
|-
* <nowiki><br></nowiki> im Code ist nicht notwendig.
! Fehler !! Kommentar
* 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.
| 1.1 || "Fachlich falscher Text"
* Überschriften sind mit Gleichheitszeichen zu setzen, nicht mit Apostrophen
|-
* Überschrift-Ebenen beachten
| 1.2 || "Code besser kennzeichnen"
* Aufzählungen einheitlich halten
|-
| 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==
=== Prüfungsfragen ===
#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 <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


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


== Kritik/Anregungen/Verbesserungsvorschläge ==
== Kritik/Anregungen/Verbesserungsvorschläge ==
*Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
* Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
*Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
* Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
*Wer meint fertig zu sein; im OP melden, Link einfügen.
* Wer meint fertig zu sein; im OP melden, Link einfügen.
 
<noinclude>


[[Category:Projektmanagement]]
== Anhang ==
[[Category:Openproject]]
=== Siehe auch ===
[[Category:Mediawiki]]
* [[MediaWiki/Artikel/Erstellen]]
----
{{Special:PrefixIndex/MediaWiki/}}


==== Links ====
===== Weblinks =====


{{PAGEID}}
[[Kategorie:MediaWiki/Anleitung]]
</noinclude>

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.

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

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


Links

Weblinks