Versionshinweise aus Commit-Informationen verfassen
Versionshinweise erklären Änderungen, die für die Zielgruppe wichtig sind. Commit-Texte liefern Anhaltspunkte, doch der Entwurf muss sichtbares Nutzerverhalten weiterhin von interner Wartung unterscheiden.
Beginne mit dem richtigen Material.
- Was du bereitstellst
- eine sichtbare Liste von Commits oder zusammengeführten Änderungen.
- Das beabsichtigte Ergebnis
- Speichere gruppierte Versionshinweise mit Verweisen und ausdrücklichen Unsicherheiten zur Auswirkung auf Nutzer.
So funktioniert der Ablauf.
Gruppiere die bereitgestellten Änderungen nach ihrer praktischen Wirkung und bewahre hilfreiche Issue- oder Commit-Verweise. Markiere unklare Einträge zur Klärung, statt die Bedeutung abgekürzter Nachrichten zu erraten.
Was du am Ergebnis prüfen solltest.
Prüfe, ob die Änderungen tatsächlich in der vorgesehenen Version enthalten sind. Eine Commit-Nachricht allein belegt weder Bereitstellung noch Verfügbarkeit oder die vollständigen Auswirkungen auf Nutzer.
Prüfe in der Markdown-Vorschau neben dem Text auch Überschriften, Listen und Links. Bewahre Quellenverweise im Dokument auf, damit Prüfer wichtige Aussagen auf dein bereitgestelltes Material zurückführen können.
Lerne am ausgearbeiteten Beispiel.
Das herunterladbare Markdown-Beispiel zeigt eine mögliche Gliederung des Ergebnisses. Lies es neben dem Quellbeispiel und unterscheide dokumentierte Fakten, vorgeschlagene Formulierungen und noch offene Fragen.
Das bereitgestellte Beispiel dient zur Veranschaulichung. Es ist kein aufgezeichneter Durchlauf mit deinen Daten.
Beispiel herunterladen ↓Nutze es mit deinem eigenen Material.
- Öffne die gewünschte Quelle und aktiviere WebAct in diesem Tab.
- Kopiere die Aufgabe aus dem oberen Seitenbereich, ergänze nötige Felder oder Wünsche und prüfe die vorgeschlagenen Aktionen.
- Vergleiche das erste Ergebnis mit deiner Quelle. Bitte bei Bedarf um eine konkrete Korrektur oder Verfeinerung.