MediaWiki/Checkliste: Unterschied zwischen den Versionen

Aus Foxwiki
Keine Bearbeitungszusammenfassung
(Änderungen von Dirkwagner (Diskussion) wurden auf die letzte Version von Alexanderrogers zurückgesetzt)
Markierung: Zurücksetzung
 
(80 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Dies ist eine Checkliste zum Überprüfen der Tickets und der Wiki-Seiten.
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


==Checkliste:Ticket==
==Zusammenfassung==
===Ziele===


[[Datei:arbeitspaket.png|thumb|275px|right]]
# Grundlage für Präsentation
===Ticket===
# Informationsentnahme erleichtern
#Name des Arbeitspakets kurz halten.
#In der Beschreibung die Ziele des Arbeitspakets angeben
#Ergebnisse in der Beschreibung verlinken.
#Zuständigkeit und Verantwortung eingeben.


===Zeit===
===Verbesserungen===
#Zeitabschätzungen nach eigenem Willen und Leistungsansprüchen anpassen. (So realistisch wie möglich bleiben!)
#Enddatum angeben
#Priorität setzen


===Zuständigkeiten abgeben===
# OP-Ticket-Link angeben
[[Datei:arbeitspaket_2.png|thumb|500px|right]]
# Rechtschreibung
#Wer mit der Aufgabe fertig ist oder Probleme auftreten, auf "Zugewiesen an" klicken und an den zuständigen Teamleiter (od. Projektleiter) senden.
# Einführung hinzufügen
#Bei der Überweisung ein Kommentar abgeben, warum man es abgegeben hat (bspw. Aufgabe fertig, Problem, Unklarheiten).
# Gliederung
#Bitte gründlich und klar formulieren, unkommentierte Überweisungen werden zurückgeschickt.
# Formatierung
# Wiki-Syntax verbessern
# Texte in Stichpunkte umwandeln
# Beispiele
## Alle wichtigen Anwendungsfälle
## Bildschirmausgaben als Text, nicht als Grafik
# Links
## Intern (andere Artikel in wiki.itw-berlin.net)
## Extern
## Quellen
### Primärquelle angeben
### Projekt-Homepage
# Visualisierung
## Komplexe Zusammenhänge visualisieren
## Diagramme im SVG-Format einbinden
# Übersetzen
# Kategorisierung


===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===
*Prozentzeichen hinter jedem Punkt zeigen an, wie viel in dem Bereich gemacht werden muss
Dies sind Standardkommentare, die genutzt werden sollen, wenn ihr etwas zu bemängeln habt und die APs überweist.
*Bei 100% ist das Kriterium erfüllt.
{| 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==
==Qualitätskriterien - Formale und inhaltliche Kriterien==


=== Inhalt ===
===Inhalt===
# Inhalte müssen fachlich korrekt sein
* Inhalte müssen fachlich korrekt sein
# 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
* Keinen Hinweis schreiben, dass ein Artikel bearbeitet werden muss.


=== Rechtschreibung, Grammatik und Interpunktion ===
===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.
* Keine doppelten Satzzeichen
* Keine Satzzeichen in Überschriften


=== Text & Gliederung ===
===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.
* Keine Nummerierung in Überschriften. (Übernimmt die Wiki!)
#Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
* Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
#Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.
* 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 ===
===Visualisierungen & Bilder===
#Nur Bilder auf eine Seite platzieren, die zum Thema passen.
* Bei farbigen Markierungen bitte angeben, wofür die Farbe steht.
#Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
* Nur Bilder auf eine Seite platzieren, die zum Thema passen.
* Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
* Bilder bitte am rechten Rand der Wiki-Seite platzieren.


=== Quellenangaben ===
===Quellenangaben und Links===
#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.
* Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
#Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
* Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
* Externe und interne Links numerisch auflisten.
* Wiki-Seiten bitte kategorisieren.


=== Links ===
==Syntax==
#Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
#Wiki-Seiten bitte kategorisieren.


=== Kommentare ===
===HTML===
Die Kommentare bitte in OpenProject und in die Diskussionsseite der entsprechenden Wiki-Seite eintragen, wenn ihr die Zuständigkeit abgegeben wollt.
* Es darf nur Wiki-Syntax verwendet werden (''Keine HTML-Syntax verwenden!'')
{| class="wikitable"
* HTML-Tags sind nur bei Anforderungen des Projektleiters erwünscht
|-
* Ausnahme bei HTML-Codes: Einsetzen der Klappfenster (Einzusetzen bei Prüfungsfragen!)
! 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"
|}


=== Kritik/Anregungen/Verbesserungsvorschläge ===
===Wiki-Syntax===
* 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
 
==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.
==Links==
# [[Wiki-Artikel erstellen]]
# https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103


[[Category:Projektmanagement]]
[[Category:Projektmanagement]]
[[Category:Openproject]]
[[Category:Openproject]]
[[Category:Mediawiki]]
[[Category:Wiki]]
 
 
{{PAGEID}}

Aktuelle Version vom 23. Juni 2024, 04:52 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

Zusammenfassung[Bearbeiten | Quelltext bearbeiten]

Ziele[Bearbeiten | Quelltext bearbeiten]

  1. Grundlage für Präsentation
  2. Informationsentnahme erleichtern

Verbesserungen[Bearbeiten | Quelltext bearbeiten]

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

  • Prozentzeichen hinter jedem Punkt zeigen an, wie viel in dem Bereich gemacht werden muss
  • Bei 100% ist das Kriterium erfüllt.

Qualitätskriterien - Formale und inhaltliche Kriterien[Bearbeiten | Quelltext bearbeiten]

Inhalt[Bearbeiten | Quelltext bearbeiten]

  • 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[Bearbeiten | Quelltext bearbeiten]

  • 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[Bearbeiten | Quelltext bearbeiten]

  • Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
  • Keine Nummerierung in Überschriften. (Übernimmt die Wiki!)
  • 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.

Visualisierungen & Bilder[Bearbeiten | Quelltext bearbeiten]

  • Bei farbigen Markierungen bitte angeben, wofür die Farbe steht.
  • Nur Bilder auf eine Seite platzieren, die zum Thema passen.
  • Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
  • Bilder bitte am rechten Rand der Wiki-Seite platzieren.

Quellenangaben und Links[Bearbeiten | Quelltext bearbeiten]

  • Alle Inhalte müssen durch eine Quelle angegeben werden.
  • Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
  • Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
  • Externe und interne Links numerisch auflisten.
  • Wiki-Seiten bitte kategorisieren.

Syntax[Bearbeiten | Quelltext bearbeiten]

HTML[Bearbeiten | Quelltext bearbeiten]

  • 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[Bearbeiten | Quelltext bearbeiten]

  • 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[Bearbeiten | Quelltext bearbeiten]

  • 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[Bearbeiten | Quelltext bearbeiten]

  1. Wiki-Artikel erstellen
  2. https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103


503