Änderungen technischer Dokumentation genau zusammenfassen
Eine Zusammenfassung von Dokumentationsänderungen hilft, aktualisierte Anweisungen, Schnittstellen oder Annahmen zu finden. Sie ist nützlich, wenn die betreffenden Versionen oder Änderungsaufzeichnungen gemeinsam vorliegen.
Beginne mit dem richtigen Material.
- Was du bereitstellst
- zwei gemeinsam bereitgestellte Dokumentationsversionen oder eine aufgeklappte Text-Diff-Ansicht.
- Das beabsichtigte Ergebnis
- Speichere geänderte Anweisungen, entfernte Schritte und Migrationsfragen, ohne Befehle auszuführen.
So funktioniert der Ablauf.
Vergleiche entsprechende Abschnitte und erkläre wesentliche Ergänzungen, Entfernungen und Überarbeitungen. Bewahre genaue Namen und Versionsverweise, wenn kleine Formulierungsänderungen Verhalten oder Kompatibilität betreffen.
Was du am Ergebnis prüfen solltest.
Prüfe die Zusammenfassung gegen beide Versionen. Ein geänderter Satz beweist keine Änderung der Software selbst, und fehlendes Material in einem Auszug kann unvollständige Abdeckung statt bewusster Entfernung bedeuten.
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.