MediaWiki/Checkliste: Unterschied zwischen den Versionen
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 | 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== | ||
===Ziele=== | |||
# Grundlage für Präsentation | |||
# Informationsentnahme erleichtern | |||
# | |||
# | |||
=== | ===Verbesserungen=== | ||
# 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 - Formale und inhaltliche Kriterien== | ||
=== Inhalt === | ===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 | |||
* 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. | |||
* 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). | |||
* 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. | |||
=== Bilder === | ===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 === | ===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!) | |||
! | |||
=== 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: | [[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]
- Grundlage für Präsentation
- Informationsentnahme erleichtern
Verbesserungen[Bearbeiten | Quelltext bearbeiten]
- 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[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]
- Wiki-Artikel erstellen
- https://projekte.foxtom.de/projects/itw-bit19it10/work_packages/662/activity?query_id=103
503