MediaWiki/Checkliste: Unterschied zwischen den Versionen

Aus Foxwiki
K Textersetzung - „== Syntax ==“ durch „== Aufruf ==“
 
(52 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
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
'''MediaWiki/Checkliste''' - Verbesserungsmöglichkeiten für Wiki-Artikel finden


==Zusammenfassung==
== Beschreibung ==
===Ziele===
; Ziele
Wiki-Artikel sollen als Grundlage für eine Präsentation dienen können


# Grundlage für Präsentation
; Informationsentnahme erleichtern
# Informationsentnahme erleichtern
* Kurze Text
 
* Klare Gliederung
===Verbesserungen===
* Eindeutige Formatierung
 
# OP-Ticket-Link angeben
# Rechtschreibung
# Einführung hinzufügen
# Gliederung
# 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
 
----
 
*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==


== Qualitätskriterien ==
===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
* 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.
* Fehlerfreies Deutsch
* 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).
* Texte in wichtige Punkte gliedern (Abschnitt, Kapitel, Unterkapitel).
* Keine Nummerierung in Überschriften. (Übernimmt die Wiki!)
* Keine Nummerierung in Überschriften
* Möglichst in Stichpunkten das Wichtigste über ein Thema schreiben.
* In Stichpunkten das Wichtigste über ein Thema schreiben.
* Bei Formatierungen gilt: So viel wie nötig, so wenig wie möglich.
* Formatierungen: So viel wie nötig, so wenig wie möglich.
* Nummerierte Auflistungen sind vornehmlich für Schritt-für-Schritt-Anweisungen reserviert.


===Visualisierungen & Bilder===
===Visualisierungen & Bilder===
* Bei farbigen Markierungen bitte angeben, wofür die Farbe steht.
* Farbige Markierungen
* Nur Bilder auf eine Seite platzieren, die zum Thema passen.
** angeben, wofür die Farbe steht
* Möglichst Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
* Bilder verwenden, die einen Sachverhalt, Prozess oder Ablauf einfach darstellen.
* Bilder bitte am rechten Rand der Wiki-Seite platzieren.
 
=== Kategorien ===
* Alle Wiki-Seiten MÜSSEN passend kategorisiert werden.


===Quellenangaben und Links===
===Quellenangaben und Links===
* Alle Inhalte müssen durch eine Quelle angegeben werden.
* Inhalte MÜSSEN durch Quellen belegt werden
* Quellen aus Internetseiten bitte mit der gesamten URL verlinken.
** Gesamte URL
* Wiki-Seiten wenn möglich mit anderen Wiki-Seiten verlinken.
**
* Externe und interne Links numerisch auflisten.
* 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===
=== Aufruf ===
* Es SOLLTE Wiki-Syntax verwendet werden, HTML-Syntax SOLLTE vermieden werden
* Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
* Entweder die Leerzeile oder den <nowiki><code></nowiki>-Block verwenden, nicht beides.
* <nowiki><br></nowiki> im Code ist nicht notwendig.
* <nowiki><br></nowiki> im Code ist nicht notwendig.
Zeile 86: Zeile 48:
* Aufzählungen einheitlich halten
* Aufzählungen einheitlich halten


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


==Links==
== Kritik/Anregungen/Verbesserungsvorschläge ==
# [[Wiki-Artikel erstellen]]
* Bei Verbesserungen und/oder Kritiken bitte die Diskussionsseite der entsprechenden Wiki-Seite benutzen.
# https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103
* Unklarheiten melden (sei es in der Diskussionsseite oder im OpenProject)
* Wer meint fertig zu sein; im OP melden, Link einfügen.


[[Category:Projektmanagement]]
<noinclude>
[[Category:Openproject]]
 
[[Category:Wiki]]
== Anhang ==
=== Siehe auch ===
* [[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