Interview mit den Autorinnen von „Technische Dokumentation für Softwareprodukte“
Technische Dokumentation für Softwareprodukte steht heute zwischen vielen Anforderungen: agile Entwicklung, steigende Tool-Komplexität, neue Erwartungen an Usability und zunehmend auch der Einsatz von KI. Gleichzeitig fehlt es in der Praxis an konkreter, moderner Orientierung.
Mit ihrem Buch „Technische Dokumentation für Softwareprodukte“ wollen Alexandra Schmidt und Alina Riechmann genau diese Lücke schließen. Dabei greifen sie bewusst auf Erfahrungen aus der praktischen Arbeit mit modernen Redaktionssystemen zurück. Wir haben mit ihnen über Motivation, Herausforderungen und Zukunft der Technischen Dokumentation gesprochen.
Zwei Perspektiven, ein gemeinsamer Blick auf sehr gute Dokumentation
Alexandra Schmidt arbeitet seit fast 20 Jahren im Bereich Information Management und Technische Dokumentation, ein Feld, das sie bis heute begeistert. Ihr Schwerpunkt liegt darauf, komplexe Inhalte verständlich und konsequent nutzenorientiert aufzubereiten. Besonders beschäftigt sie die Frage, wie Wissen so vermittelt werden kann, dass es wirklich beim User ankommt.
Alina Riechmann ist als Technische Redakteurin tätig und ursprünglich nicht aus diesem Berufsfeld gekommen. Sie beschreibt ihren Einstieg als eine Phase, in der sie den Beruf selbst zunächst gar nicht kannte. Genau daraus entsteht bis heute ihr Arbeitsstil: ein unverstellter Blick auf Inhalte und Prozesse.
„Ich stelle viele Fragen und hinterfrage Dinge, die für andere längst selbstverständlich sind“, so Alina. Diese Perspektive ergänzt sich gut mit Alexandras langjähriger Erfahrung und ihrem strategischen Blick.
Wie das Buch entstanden ist
Die Idee zum Buch entstand direkt aus dem Arbeitsalltag. Alexandra berichtet, dass sie in vielen Meetings immer wieder dieselben Grundlagen zur Softwaredokumentation erklären musste.
„Irgendwann kam der Gedanke: Warum schreiben wir das nicht einfach auf?“
Was als spontane Idee begann, entwickelte sich schnell zu einem konkreten Projekt, ausgelöst durch die erkennbare Lücke in der Technischen Dokumentation. Noch immer dient der Maschinenbau häufig als Referenz, während für moderne Softwareprodukte praxisnahe und aktuelle Literatur fehlt. Ziel war daher ein bewusst anderer Ansatz: niedrigschwellig, praxisnah und ohne akademische Überfrachtung.
Ein zentrales Problem sehen die Autorinnen in der Übertragung klassischer Denkweisen auf die Softwaredokumentation. Alina beschreibt:
„Oft wird ein Denken aus dem Maschinenbau auf Software übertragen. Dabei gilt Software schnell als selbsterklärend, weil Oberflächen intuitiv wirken. Das führt dann dazu, dass Dokumentation auf einfache Beschreibungen ohne echten Mehrwert reduziert wird.“
Entscheidend sei also das Verständnis dafür, was User wirklich brauchen, um ihr Ziel zu erreichen. Alexandra ergänzt diesen Ansatz um den Fokus auf Use Cases: statt reine „Screenshot-Galerien“ abzubilden, gehe es darum, vom Ziel der Nutzenden aus zu denken. Nicht der Menüpunkt steht im Mittelpunkt, sondern die Frage, wie User ihr Ziel effizient erreichen.
Wie verändert sich das Berufsbild der Technischen Redaktion in agilen Teams?
Die Rolle Technischer Redakteur:innen befindet sich im Umbruch. Lange Zeit wurden sie erst spät in Projekte eingebunden, arbeiteten weitgehend für sich und kamen häufig erst dann ins Spiel, wenn ein Produkt inhaltlich bereits abgeschlossen war. Dieses Modell hat früher funktioniert, heute reicht es nicht mehr aus.
Alexandra beschreibt diesen Wandel sehr plastisch: Technische Redakteur:innen haben lange „im sprichwörtlichen stillen Kämmerchen“ gesessen. Heute hingegen müssen sie im Sprint mitlaufen, an Meetings teilnehmen, parallel zur Entwicklung recherchieren und Produkte kontinuierlich und iterativ begleiten – auf Augenhöhe mit Entwicklung, Produktmanagement und UX.
Mit dieser veränderten Rolle gehen neue Anforderungen einher. Themen wie KI, Innovation und die eigene Sichtbarkeit im Unternehmen gewinnen zunehmend an Bedeutung. Technische Redakteur:innen müssen bereit sein, sich kontinuierlich weiterzuentwickeln, neue Werkzeuge zu verstehen und ihre Rolle aktiv zu vertreten, um in modernen Softwareprojekten wirksam zu bleiben.
„Stillstand funktioniert in diesem Umfeld einfach nicht mehr.“ (Alexandra)
KI als Werkzeug, nicht als Ersatz
Beim Thema Künstliche Intelligenz verfolgen Alexandra und Alina einen bewusst pragmatischen Ansatz. Ziel ist es vor allem, Unsicherheiten abzubauen und Neugier zu fördern. Alexandra bringt diese Haltung auf den Punkt:
„Wer sich nicht aktiv mit KI beschäftigt, wird irgendwann überholt.“
Gleichzeitig machen die Autorinnen deutlich, dass KI ihr Potenzial nur dann entfalten kann, wenn sie gezielt eingesetzt wird. Im Buch benennen sie deshalb nicht nur Chancen, sondern auch Grenzen. KI kann Inhalte vorbereiten, Auswertungen beschleunigen oder beim Strukturieren unterstützen. Fachliche Verantwortung, Einordnung und Qualitätssicherung bleiben jedoch menschliche Aufgaben.
Alina betont, dass menschliche Expertise dadurch nicht ersetzt wird. Vielmehr gehe es darum, KI bewusst als Unterstützung zu nutzen. „KI sollte man als Werkzeug verstehen, nicht als Ersatz für die eigene Expertise.“
In der redaktionellen Praxis sehen beide großes Potenzial vor allem bei vorbereitenden und wiederkehrenden Aufgaben: beim Strukturieren von Inhalten, dem Zusammenfassen komplexer Informationen oder Erstellen erster Textentwürfe. Gerade der Einstieg in neue Themen fällt dadurch leichter, ohne dass redaktionelle Verantwortung abgegeben wird.
Wie bringt man Ordnung in komplexe Softwaredokumentation?
Um Ordnung in gewachsene und oft komplexe Softwaredokumentation zu bringen, setzen Alexandra und Alina an einer grundlegenden Frage an: dem Ziel. Statt bestehende Inhalte lediglich zu sortieren oder zu erweitern, plädiert Alexandra dafür, „vom Ende her zu denken“ und sich bewusst zu machen, wohin die Dokumentation führen soll. Sobald dieses Ziel definiert ist, werde schnell sichtbar, welche Inhalte tatsächlich benötigt werden und welche nur deshalb existieren, weil sie „schon immer da waren“.
Entscheidend sei, erfahrene Beteiligte und relevante Stakeholder einzubinden, um gemeinsam weiterzuarbeiten, statt Strukturen isoliert zu optimieren.
Alina ergänzt diesen Ansatz um die konsequente Userperspektive:
„Für wen schreibe ich eigentlich? Welches Vorwissen bringen die User mit, welche Erwartungen haben sie? Eine saubere Zielgruppenanalyse ist dabei ein entscheidender Schritt. Sie hilft nicht nur, Inhalte besser zu strukturieren, sondern auch die richtige Tiefe und Tonalität zu finden.“
Smart Media Creator: Warum ein CCMS entscheidend für skalierbare Softwaredokumentation ist
Ohne geeignete Systeme ist professionelle Softwaredokumentation kaum effizient zu bewältigen. Klassische Textverarbeitung stößt bei Versionierung, Zusammenarbeit und Wiederverwendung schnell an Grenzen. Alexandra findet die Lösung eindeutig: „Für diesen Bereich braucht es ein CCMS – Punkt.“ Welches System im Einzelfall passt, hängt von Größe, Reifegrad und Zielen eines Unternehmens ab.
Im Arbeitsalltag der beiden spielt der Smart Media Creator (SMC) eine zentrale Rolle. Das System dient ihnen nicht nur als Beispiel im Buch, sondern wird aktiv im Arbeitsalltag eingesetzt.
„Der Einstieg in den SMC ist niedrigschwellig, selbst für Menschen ohne viel Erfahrung im CCMS-Umfeld“, erklärt Alina.
Besonders schätzen beide die Kombination aus Benutzerfreundlichkeit und Funktionsumfang. Auch die Integration von Produktdaten (PIM) wird als Vorteil gesehen, da Inhalte dadurch über klassische Dokumentationsgrenzen hinaus nutzbar werden.
Alexandra beschreibt den praktischen Nutzen so: „Uns überzeugt die Mischung aus Usability, Funktionsumfang und Wirtschaftlichkeit.“ Ergänzt wird dieser Eindruck durch die Erfahrung in der Zusammenarbeit: Vom ersten Kontakt über die Einführung bis hin zum täglichen Arbeiten erlebe man den Umgang als stimmig und verlässlich.
Der Smart Media Creator steht im Gespräch stellvertretend für einen Ansatz, der professionelle Dokumentation ermöglicht, ohne Einstiegshürden unnötig zu erhöhen.
Woran zeigt sich sehr gute Dokumentation?
Ob Dokumentation letztendlich hilft, zeigt sich für Alexandra und Alina vor allem im Nutzungskontext und anhand konkreter Indikatoren. Sinkende Support-Anfragen gehören für sie zu den wichtigsten Messgrößen, denn weniger Support-Tickets bedeuten in der Regel, dass Informationen verständlich sind und Nutzende selbstständig ans Ziel kommen.
Gleichzeitig spielt direktes Kundenfeedback eine große Rolle. Immer wieder hören sie, dass Produkte gerade wegen der verständlichen Infoprodukte und Videos als intuitiv wahrgenommen werden. Sehr gute Dokumentation wirkt damit nicht nur unterstützend, sondern auch als Faktor für Kaufentscheidung und Kundenbindung.
Vor diesem Hintergrund passt der oft gehörte Satz „Doku liest eh keiner“ für sie schlicht nicht zur Realität. Rückmeldungen von Nutzenden – egal ob positiv oder kritisch – sind ausdrücklich erwünscht. Genau diese Offenheit macht Dokumentation langfristig besser.
Blick nach vorn: verständlicher, sichtbarer, zugänglicher
Für die Zukunft wünschen sich beide vor allem, dass Technische Redaktion als das wahrgenommen wird, was sie heute ist: eine zentrale Funktion im Unternehmen.
Alexandra plädiert dafür, sichtbarer zu werden, früh Verantwortung zu übernehmen und den eigenen Beitrag selbstbewusst zu vertreten. Gerade im Zusammenspiel mit KI werde diese Rolle weiter an Bedeutung gewinnen, denn Entscheidungen über Relevanz, Qualität oder Barrierefreiheit lassen sich nicht automatisieren. „KI kann nur mit dem arbeiten, was ihr Menschen an strukturierter, korrekter Information geben“, bringt sie es auf den Punkt.
Alina richtet den Blick stärker auf den Arbeitsalltag. Professionelle Dokumentation brauche Werkzeuge, die Zusammenarbeit, Versionierung und Qualität unterstützen, statt sie unnötig zu erschweren. Darüber hinaus teilen beide den Wunsch nach mehr Fokus auf Barrierefreiheit und verständliche Sprache. Dokumentation sollte weniger technisch verkopft sein, mehr Menschen erreichen und damit die Grundlage für nachhaltige Produktkommunikation der nächsten Jahre bilden.
Zwischen agiler Entwicklung, neuen Tools und KI bleibt eines zentral: der Fokus auf den Menschen, der Inhalte tatsächlich nutzt. Oder, wie Alexandra es formuliert:
„Technische Redaktion ist heute eine Schlüsselfunktion im Unternehmen.“
Buchempfehlung
Mit „Technische Dokumentation für Softwareprodukte“ haben Alexandra Schmidt und Alina Riechmann ein praxisnahes Buch geschaffen, das sich gezielt an Technische Redakteur:innen im Softwareumfeld richtet.
Das Buch verbindet konkrete Erfahrungen aus dem Arbeitsalltag mit klaren Handlungsempfehlungen und zeigt, wie moderne Softwaredokumentation heute jenseits klassischer Maschinenbau-Paradigmen gelebt werden kann.
Besonders wertvoll ist das Buch für alle, die in agilen Umfeldern arbeiten, sich mit neuen Tools und KI auseinandersetzen und gleichzeitig den Anspruch haben, Dokumentation wirklich nutzenorientiert zu gestalten.
Erhältlich ist der Titel über Book on Demand (BoD) sowie über weitere gängige Online-Buchshops.