| title | tags |
|---|---|
Review Template |
orga |
Pro Beitrag werden den Teilnehmer:innen von MPS durch das MPS-Team drei Beiträge für ein Review zugeordnet. Die Reviewer:innen sollten entsprechend eine Mail von GitHub erhalten, in der sie zu einem Review eingeladen werden. Bei Öffnen des Pull-Requests des zu prüfenden Beitrags erscheint oben eine Aufforderung zum Review.
Der Screencast Screencast_Review_Process zeigt, in welchen Schritten ein Review zu einem Beitrag erstellt wird.
Wie im Video zu sehen, soll dazu die folgende Bewertungstabelle inklusive der Zusammenfassung, positiven und negativen Aspekte kopiert und in das Kommentarfeld eingefügt werden (am besten die Datei als "Raw" anzeigen lassen zum Kopieren):
---kopieren ab hier---
| Kriterium | Bewertung |
|---|---|
| Front-Matter | ja/ nein |
| Umfang | ja/ nein |
| Belege | ja/ nein |
| Links | ja/ nein |
| Formatierung | ja/ nein |
| Verlinkungen vorhanden | ja/ nein |
| Abbildungen | ja/ nein |
| Strukturierung des Beitrags | 1-10 |
| Rechtschreibung | 1-10 |
| Sprache | 1-10 |
| Inhalt | 1-10 |
| Einordnung in den Kontext | 1-10 |
| Ansprechend für Zielgruppe | 1-10 |
Kurze Zusammenfassung des/der Artikel
Was ist gut (Bezug zur Tabelle)
Was geht besser (Bezug zur Tabelle)
---kopieren bis hier---
In den Feldern mit Auswahlmöglichkeit "ja/ nein" soll lediglich eine Option gewählt werden (Angabe "ja" ODER "nein"). In den Feldern mit "1-10" soll eine Bewertung in Form einer ganzen Zahl von 1 bis 10 abgegeben werden, wobei 10 die Bestnote darstellt (Z.B. Eintrag von "5"). Beispiel:
| Kriterium | Bewertung |
|---|---|
| Abbildungen | ja |
| Strukturierung des Beitrags | 5 |
In der folgenden Tabelle, die lediglich als Hilfestellung dient und nicht kopiert werden soll, sind Erklärungen zu den einzelnen Bewertungskriterien gegeben, um die Bedeutung der Kriterien klarzustellen.
| Kriterium | Erklärung | Bewertung |
|---|---|---|
| Front-Matter | Metadaten im Front-Matter korrekt ausgefüllt | ja/ nein |
| Umfang | ca. 500 Wörter ohne Quellenverweise | ja/ nein |
| Belege | Quellen zu den Inhalten angegeben (auch bei Abbildungen) | ja/ nein |
| Links | Funktionieren alle Links | ja/ nein |
| Formatierung | Korrekte Formatierung wie z.B. Überschriften zur Strukturierung, Punktelisten für Aufzählungen | ja/ nein |
| Verlinkungen vorhanden | Zu Unter- und Überthemen sowie zu angrenzenden Themengebieten | ja/ nein |
| Abbildungen | Mindestens eine Abbildung / Visualisierung | ja/ nein |
| Strukturierung des Beitrags | Ist der Beitrag inhaltlich und visuell (z.B. durch Überschriften) gut strukturiert? | 1-10 |
| Rechtschreibung | Korrekte Rechtschreibung und Grammatik | 1-10 |
| Sprache | Deutsch, Sachlich (Enzyklopädiestil s. Wikipedia) | 1-10 |
| Inhalt | Inhaltliche Korrektheit, wichtigste Aspekte zum Thema sind vorhanden | 1-10 |
| Einordnung in den Kontext | Einordnung in Bezug auf angrenzende Themengebiete | 1-10 |
| Ansprechend für Zielgruppe | Kommiliton:innen erhalten durch den Beitrag einen guten Überblick über das entsprechende Thema, haben Spaß beim Lesen des Artikels und folgen den Verlinkungen | 1-10 |
Unter der Bewertungstabelle soll außerdem unter dem Punkt "Zusammenfassung" in Textform eine kurze Zusammenfassung des Beitrages gegeben werden. Darunter sollen positive und negative Aspekte des Berichts beleuchtet werden, um nochmals kurz die vergebenen Bewertungen in der Tabelle zu begründen.