Acht Yoga-Übungen für bessere Release-Notes

Zugehörige Leistung: Softwaredokumentation

Sie sind kurz davor, Ihr nächstes Software-Release auszuliefern? Herzlichen Glückwunsch, das war wieder ein hartes Stück Arbeit. Jetzt müssen Sie nur noch fix die Release-Notes schreiben. Und mit „noch fix“ haben wir auch schon das Problem. So häufig werden Release-Notes auf den letzten Pfiff erstellt. Aber sie gehören ja leider zum Release. Was manchmal dabei herauskommt: Eine Release-Note, die hastig zusammengestellt und voller Fachjargon ist. Und viele ratlose Anwender:innen.  

Und was hat das mit Yoga zu tun?

Sie wissen das: Im Yoga kommen wir zur Ruhe, wir entschleunigen und erhalten, wenn es gut läuft, einen klareren Blick auf das Wesentliche. Und genau darum geht es in Release-Notes: um das Wesentliche. Also rollen Sie schon mal Ihre Yogamatte aus, während ich einen kurzen Ausfallschritt zurück mache: 

Was sind Release-Notes? 

Release-Notes bieten eine Übersicht über Änderungen, Verbesserungen und Fehlerbehebungen (Bugfixes) und werden zusammen mit einer neuen Version einer Software veröffentlicht.  

Jetzt geht es auch schon los: Mit acht Yoga-Übungen (Asanas) und vielen Yogi-Tipps für bessere Release-Notes. 

1. Tadasana – die Bergstellung. Für eine starke Struktur 

In der Bergstellung finden wir innere Ruhe, fühlen uns stark wie ein Berg und haben das Gefühl, mit beiden Füßen fest im Leben zu stehen. 

Auch Ihre Anwender:innen stehen mit beiden Füßen fest im Leben. Sie lesen Ihre Release-Notes nämlich aus einem Grund: Sie wollen wissen, was sich geändert hat und ob die Änderungen für sie relevant sind. Die meisten werden die Release-Notes deswegen nur kurz überfliegen.  

Machen Sie Ihre Release-Note also „überfliegbar“. Dafür sollten Sie sie gut strukturieren und wichtige Schlagworte fett auszeichnen.  

Yogi-Tipp: Verwenden Sie zum Strukturieren Kategorien, Überschriften, Listen und Absätze. 

Yogi-Tipp: Unterscheiden Sie zwischen Features und Bugfixes. Führen Sie neue Funktionen in „Features“ auf. Fehlerlösungen gehören unter „Bugfixes“. 

Beispiel 

Lines for carriage information on transport orders | Feature
You can now print lines with carriage information on transport orders. In the Transport Order tab, we added the check box Carriage Info. When you activate Carriage Info, the software prints the information on the weight of the goods on the transport order. 

2. Anjaneyasana – der Ausfallschritt für bessere Überschriften 

Der Ausfallschritt sorgt für bessere Koordination und Konzentrationsfähigkeit und hilft Ihnen, Ihre körperliche und innere Stärke zu spüren. Gehen Sie in den Ausfallschritt, heben Sie die Arme und spüren Sie die Macht der Überschriften. 

Manche Autor:innen von Release-Notes wollen so viele Informationen wie möglich in der Überschrift unterbringen. Und da nach einer Überschrift gewöhnlich Text kommt, wiederholen sie den Text aus der Überschrift, nur ausführlicher.  

Yogi-Tipp: Wählen Sie eine Überschrift, die besagt, was Sie geändert haben oder was neu ist. Im Text darunter beschreiben Sie, wie die Anwender:innen das neue Feature verwenden oder darauf zugreifen.  

Beispiel 

Erstellen von Links vereinfacht | Feature 5698 
Sie können nun einfacher Links erstellen. Markieren Sie den Text, klicken Sie mit der rechten Maustaste und wählen Sie aus dem Kontextmenü Link erstellen.  

Manchmal lesen wir auch, dass ein Bug 8976.1 in Version 3.4.1 behoben wurde. Sie als Autor:in der Release-Note wissen vermutlich, was gemeint ist – die Anwender:innen aber verstehen wahrscheinlich nur Bahnhof.  

Yogi-Tipp: Formulieren Sie Überschriften, die Ihre Leser:innen verstehen, zum Beispiel „Probleme bei der Vorschau von Bildern behoben | Bug 3489“.

3. Bhujangasana – die Cobra. Für eine direkte Ansprache 

Die Cobra kann sich am Anfang etwas unangenehm anfühlen, insbesondere, wenn Sie Rückenprobleme haben.

Auch das direkte Ansprechen Ihrer Anwender:innen könnte zunächst etwas ungewohnt sein, aber ich verspreche Ihnen, es lohnt sich. Ihre Release-Note wird dadurch persönlicher und Ihre Leser fühlen sich verstanden.  

Yogi-Tipp: Verwenden Sie möglichst aktive Formulierungen und vermeiden Sie Passivkonstruktionen. So werden Ihre Sätze auch gleich kürzer. 

In den Release-Notes soll es übrigens um den Mehrwert für die Anwender:innen gehen, nicht so sehr um Ihr Produkt oder Ihre Firma. Machen Sie deutlich, dass Ihre Kund:innen von den Verbesserungen profitieren.  

Yogi-Tipp: Vermeiden Sie Sätze mit „wir“ oder „Firma xy“. 

Beispiel 

Automatisches Speichern von Änderungen in Dateien | Vorgang 0123
Änderungen in den Dateien in Ihrer Cloud werden jetzt automatisch gespeichert. Laden Sie Ihre Dokumente in die Cloud hoch und bearbeiten Sie sie dort direkt. Sie müssen Ihre Dateien nicht mehr lokal speichern und separat in die Cloud hochladen.  

4. Balasana – Pose des Kindes. Für klare und verständliche Sprache 

Knien Sie sich auf den Boden und setzen Sie sich auf die Fersen. Schließen Sie die Augen. 

Versetzen Sie sich nun in Ihre Anwender:innen und versuchen Sie, sich vorzustellen, was sie wissen, oder besser, was sie nicht wissen. Vergessen Sie für einen Moment Ihr Expertenwissen als Softwareentwickler:in oder Produktmanager:in. Schreiben Sie so einfach wie möglich, klar und verständlich – und vor allem: Vermeiden Sie Fachjargon. Sie wissen, was ein Patch ist, ich weiß es auch; nur einige Ihrer Anwender:innen wissen es eventuell nicht. Sie wissen jetzt aber, was Balasana ist. 

Yogi-Tipp: Verwenden Sie eine einfache, klare Sprache und sprechen Sie die Sprache der Anwender:innen. Schreiben Sie möglichst kurze Sätze, vermeiden Sie Fachjargon und Begriffe, die für die Zielgruppe zu technisch sind. 

Beispiel 

Schreiben Sie statt „Neuer Algorithmus im Backend für die Projektkostenkalkulation“ einen verständlichen, kurzen Satz ohne Fachbegriffe: „Die Gesamtkosten Ihres Projekts werden nun automatisch ausgerechnet.“ 

5. Setu Bandha Sarvangasana – die Schulterbrücke. Zum besseren Visualisieren 

Die Schulterbrücke ist eine Wohltat für Körper und Geist. Brücken können verbinden, was zusammengehört. So ist es mit Text und Bildern.

Yogi-Tipp: Platzieren Sie, wann immer möglich, Screenshots in Ihrem Text. So verbessern Sie die Verständlichkeit, gerade bei längeren und technischen Erklärungen. 

Beispiel 

Besseres Verständnis mit dem Linienfokus | Feature 983-12 
Sie können jetzt zeilenweise durch ein Dokument navigieren, ganz ohne Ablenkung. Passen Sie den Fokus an, damit eine, drei oder fünf Zeilen gleichzeitig angezeigt werden. 

6. Virabhadrasana I – der Krieger I. Für starke Verweise  

Krieger I und II sind meine liebsten Yogaposen. Ich fühle mich gleich so viel mutiger, wenn ich sie ausführe. Auch Sie können zum mutigen Krieger werden! Beim Krieger I dehnen und stärken Sie Ihre Beine und öffnen die Brust.  

Öffnen Sie Ihre Release-Notes, in dem Sie auf bestehende Dokumentation oder andere Produktinformationen verweisen, und machen Sie sie stärker. In vielen Fällen erweitern Sie eine bestehende Funktion oder passen sie an. Und da Ihr Produkt sicherlich über eine ausgezeichnete Dokumentation verfügt, fügen Sie gleich einen Link zu dem entsprechenden Thema in der Dokumentation hinzu. Interessierte Leser:innen werden es Ihnen danken.

Yogi-Tipp: Verweisen Sie von Ihren Release-Notes auf weitere Dokumentation oder Produktinformationen. 

7. Virabhadrasana II – der Krieger II. Zum Prüfen und Ehrlichsein 

Auch beim Krieger II dehnen und stärken Sie Ihre Beinmuskulatur. Gleichzeitig öffnen Sie die Arme zur Seite und sich selbst für Ihre Umwelt.

Seien Sie offen für Kritik: Lassen Sie Ihre Release-Note vor dem Veröffentlichen gegenlesen, am besten von Personen, die außerhalb Ihres Fachgebietes arbeiten. Und seien Sie ehrlich zu sich selbst: Fragen Sie sich, ob Sie Ihre Release-Note selber lesen würden.  

Yogi-Tipp: Springen Sie über Ihren Schatten und lassen Sie andere Ihre Release-Note Korrektur lesen.  

8. Shavasana – die Schlussentspannung 

Sie haben es geschafft. Jetzt kommen wir zum Entspannungsteil. Wenn Sie bis hierher gelesen haben, haben Sie Einiges geleistet. Mit Shavasana schenken Sie Ihrem Körper und Geist die ersehnte Ruhe.

Und während Sie sich auf den Rücken legen, die Arme neben dem Körper ausstrecken und die Augen schließen, flüstere ich Ihnen einen kurzen, beruhigenden Schluss-Tipp ins Ohr: Betrachten Sie Ihre Release-Notes als Gelegenheit, das Ergebnis Ihrer Arbeit zu präsentieren. Durch gut geschriebene Release-Notes binden Sie Anwender:innen, erhöhen die Begeisterung für Ihr Produkt und erreichen sogar neue Zielgruppen.