MediaWiki/Checkliste: Unterschied zwischen den Versionen

Aus Foxwiki
(Änderungen von Dirkwagner (Diskussion) wurden auf die letzte Version von Alexanderrogers zurückgesetzt)
Markierung: Zurücksetzung
 
(84 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
Dies ist eine Liste aller Qualitätskriterien, die für die Erstellung einer Wiki-Seite wichtig sind. Die Wikis dienen als Hilfe und als Leistungsnachweis für euch und andere Gruppen.
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
==Zusammenfassung==
===Ziele===


== Inhalt ==
# Grundlage für Präsentation
# Inhalte müssen fachlich korrekt sein
# Informationsentnahme erleichtern
# Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
# Prüfungsfragen eingeben


== Rechtschreibung, Grammatik und Interpunktion ==
===Verbesserungen===
# Der Text muss in fehlerfreiem Deutsch geschrieben werden.
# Englische Wörter oder Fachbegriffe bitte korrekt angeben.


== Text & Gliederung ==
# OP-Ticket-Link angeben
#Den Text in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
# Rechtschreibung
#Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
# Einführung hinzufügen
#Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
# Gliederung
#Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.
# 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


== Bilder ==
----
#Nur Bilder auf eine Seite platzieren, die zum Thema passen.
#Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.


== Quellenangaben ==
*Prozentzeichen hinter jedem Punkt zeigen an, wie viel in dem Bereich gemacht werden muss
#Alle Inhalte müssen durch eine Quelle angegeben werden.
*Bei 100% ist das Kriterium erfüllt.
#Fehlende Quellenangaben werden nicht toleriert in der Wiki.
#Quellen aus Internetseiten bitte mit der gesamten URL verlinken.


== Links ==
==Qualitätskriterien - Formale und inhaltliche Kriterien==
#Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
#Wiki-Seiten bitte kategorisieren.


== Kommentare ==
===Inhalt===
Die Kommentare bitte in OpenProject und in die Diskussionsseite der entsprechenden Wiki-Seite eintragen, wenn ihr die Zuständigkeit abgegeben wollt.
* Inhalte müssen fachlich korrekt sein
{| class="wikitable"
* Im Code bitte kennzeichnen, ob User oder Root ihn benutzen kann. ($ für User, # für Root)
|-
* Prüfungsfragen eingeben
! Fehler !! Kommentar
* Keinen Hinweis schreiben, dass ein Artikel bearbeitet werden muss.
|-
| 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 ==
===Rechtschreibung, Grammatik und Interpunktion===
* 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===
* 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===
* 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===
* 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==
 
===HTML===
* 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===
* 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:Openproject]]
[[Category:Wiki]]




[[Category:Mediawiki]]
{{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