Ich erstelle technische Dokumentationen, die Menschen dabei helfen, Software zu verstehen, komplexe Aufgaben zu bewältigen und Probleme selbstständig zu lösen.
Meine Erfahrung umfasst Benutzerhandbücher, Administratordokumentationen, Entwicklerressourcen, API-Dokumentationen, Implementierungsanleitungen, Release-Inhalte und Produktkommunikation für SaaS-, Unternehmens- und regulierte Software.
Als englischer Muttersprachler und technischer Redakteur mit umfassender Erfahrung in der Softwarequalitätssicherung verbinde ich präzise Kommunikation mit der Fähigkeit, komplexe Anwendungen zu verstehen, ihre Funktionsweise zu untersuchen und zu erkennen, an welchen Stellen Benutzer voraussichtlich auf Schwierigkeiten stoßen werden.
Die folgenden Projekte stellen ausgewählte Höhepunkte meiner Laufbahn als technischer Redakteur dar.
Langfristige Produktdokumentation für komplexe Laborsoftware
Seit 2020 bin ich alleinverantwortlicher technischer Redakteur für tick@lab, ein umfassendes Laborinformationsmanagementsystem zur Unterstützung komplexer wissenschaftlicher und betrieblicher Arbeitsabläufe.
Ich bin für die Dokumentation des Produkts über mehrere aufeinanderfolgende Releases hinweg verantwortlich und überführe die sich weiterentwickelnden Funktionen in klare Informationen für Benutzer, Administratoren und technische Zielgruppen.
Die Tätigkeit bei a-tune erfordert eine enge Zusammenarbeit mit Entwicklern, Produktspezialisten und weiteren Fachexperten. Ich untersuche neue und geänderte Funktionen selbstständig, ermittle den Informationsbedarf der Benutzer und aktualisiere die Dokumentation kontinuierlich entsprechend der Weiterentwicklung der Anwendung.
Alleinige Verantwortung für die technische Produktdokumentation
Erstellung und Pflege der Dokumentation über mehrere Software-Releases hinweg
Dokumentation komplexer Labor-, Administrations- und Konfigurationsabläufe
Erstellung von Inhalten für Benutzer mit unterschiedlichen Rollen und technischen Kenntnissen
Direkte Zusammenarbeit mit Entwicklern und Fachexperten zur Klärung von Funktionen
Prüfung neuer Funktionen und Ermittlung ihrer Auswirkungen auf die bestehende Dokumentation
Neustrukturierung und Überarbeitung von Inhalten zur Verbesserung von Klarheit, Konsistenz und Auffindbarkeit
Erstellung annotierter Screenshots und ergänzender visueller Materialien
Sicherstellung einer einheitlichen Terminologie, eines konsistenten Stils und einer einheitlichen Darstellung innerhalb der gesamten Dokumentation
Direkte Überprüfung dokumentierter Vorgehensweisen in der Anwendung
Meine langfristige Beteiligung gewährleistet Kontinuität über verschiedene Releases hinweg und stellt sicher, dass sich die Dokumentation gemeinsam mit dem Produkt weiterentwickelt, anstatt lediglich eine zusammenhanglose Aufzeichnung einzelner Funktionen zu bilden.
Durch die Verbindung technischer Redaktion mit praktischer Softwareanalyse kann ich unklare Arbeitsabläufe, fehlende Informationen und Inkonsistenzen erkennen, bevor sie die Benutzer erreichen.
Regulierte Dokumentation für dentale CAD-Software
Von 2016 bis 2024 erstellte und pflegte ich bei exocad und nach der Übernahme bei Align Technology technische Dokumentationen für anspruchsvolle dentale CAD-Anwendungen.
Die Software wurde in einem durch die FDA regulierten Medizinprodukteumfeld entwickelt, das formellen Qualitätsmanagementprozessen unterlag. Die Dokumentation musste daher präzise, kontrolliert und nachvollziehbar sein und gemäß etablierten Qualitätsstandards gepflegt werden.
Meine Arbeit umfasste interne Qualitätsdokumentation, eingebettete Produkthilfe und kundenorientierte Inhalte. Sie verband klassische technische Redaktion mit Docs-as-Code-Verfahren und einer engen Zusammenarbeit mit Beteiligten aus Entwicklung, QA, Produktmanagement und Regulatory Affairs.
Erstellung regulierter Dokumentationen für FDA-kontrollierte Medizinproduktsoftware
Erstellung von Testfallprotokollen, Runbooks, Standardarbeitsanweisungen und weiteren kontrollierten Dokumenten
Erstellung und Pflege von Inhalten mit LaTeX, Markdown und XML
Pflege der gemeinsam mit dem Quellcode der Anwendung gespeicherten eingebetteten Onlinehilfe
Verwaltung der Dokumentation über Git-basierte Docs-as-Code-Workflows
Nutzung von Git-Aktionen und Repository-Prozessen zur Prüfung, Aktualisierung und Veröffentlichung der Dokumentation
Erstellung von Benutzerhandbüchern, Release Notes und kundenorientierten Produktdokumentationen
Arbeit gemäß den Qualitätsmanagementstandards der ISO 9001
Verantwortung für die technischen Redaktionsstandards des Unternehmens und deren Pflege
Einführung einheitlicher Terminologie-, Stil-, Struktur- und Dokumentationsstandards
Tätigkeit als primärer englischer Sprachberater für technische Dokumentationen und Kundenkommunikation
Zusammenarbeit mit internationalen Entwicklungs-, QA-, Produkt- und Regulatory-Teams
Meine Arbeit trug dazu bei, dass sowohl interne als auch kundenorientierte Dokumentationen die Anforderungen eines regulierten Softwareumfelds an Genauigkeit und Konsistenz erfüllten.
Durch die Verbindung meiner Erfahrung in der technischen Redaktion mit praktischen QA-Kenntnissen und Docs-as-Code-Verfahren konnte ich formelle Compliance-Anforderungen unterstützen und gleichzeitig sicherstellen, dass die Dokumentation eng auf das sich weiterentwickelnde Produkt abgestimmt blieb.
Technische Kommunikation und Produktkommunikation für KI-gestützte Einzelhandelstechnologie
Für Signatrix erstelle ich englischsprachige Inhalte für Produkte wie AgeCheck, Self-Checkout, und Cartwatch: KI-gestützte Lösungen KI-gestützte Lösungen zur Altersüberprüfung, zur Verhinderung von Schwund und zur Sicherheit im Einzelhandel.
Die Produkte verbinden künstliche Intelligenz, Hardware im Ladengeschäft, lokale Datenverarbeitung, Kassenintegration und administrative Konfiguration. Ihre effektive Kommunikation erfordert technische Genauigkeit und muss zugleich für Einzelhändler, Entscheidungsträger, Filialmitarbeiter und weitere nichttechnische Zielgruppen verständlich bleiben.
Meine Arbeit umfasst die verständliche und visuell strukturierte Aufbereitung komplexer Informationen zu Produkt, Architektur, Datenschutz und Arbeitsabläufen.
Erstellung von kundenorientierten englischen Inhalten für die Kernprodukte von Signatrix
Übersetzung technischer Konzepte in eine klare Sprache für nichttechnische Zielgruppen
Erläuterung der KI-gestützten Altersschätzung und anderer Algorithmen, ohne die Technologie überzubewerten
Entwicklung von Ablaufbeschreibungen und unterstützenden Prozessdiagrammen
Vermittlung von Systemarchitektur- und Integrationskonzepten
Klare und präzise Darstellung von Informationen zu Datenschutz und Datenverarbeitung
Strukturierung von Inhalten anhand von Kundenfragen, Bedenken und Kaufentscheidungen
Zusammenarbeit mit Fachexperten zur Überprüfung technischer und produktbezogener Aussagen
Optimierung von Terminologie und Botschaften für ein internationales Publikum
Verbindung schriftlicher Inhalte mit Diagrammen, Hervorhebungen, Tabellen und weiteren visuellen Elementen
Englischsprachiges Lektorat auf Muttersprachlerniveau und redaktionelle Beratung
Die daraus entstandenen Inhalte helfen potenziellen Kunden, nicht nur die Funktion von AgeCheck zu verstehen, sondern auch dessen Einbindung in den Einzelhandel, den Umgang mit Kundeninteraktionen und die Berücksichtigung des Datenschutzes bei der Produktentwicklung.
Mein Beitrag schließt die Lücke zwischen der zugrunde liegenden Technologie und den Informationen, die kaufmännische und operative Entscheidungsträger benötigen.
Meine weitere Erfahrung umfasst Dokumentationen für SaaS-Plattformen, Unternehmensanwendungen, Entwicklerwerkzeuge, APIs und regulierte Softwareprodukte.
Je nach Projekt umfassten meine Aufgaben:
Benutzerhandbücher und Onlinehilfe
Administrator- und Konfigurationsdokumentation
Installations- und Implementierungsanleitungen
Entwicklerdokumentation
REST-API-Dokumentation
Release Notes und Funktionsdokumentation
Prozess- und Ablaufdokumentation
Technische Vertriebs- und Produktinhalte
Informationsarchitektur und Neustrukturierung von Inhalten
Entwicklung von Terminologie- und Styleguides
Erstellung von Screenshots und Bildannotationen
Dokumentationsprüfungen und Qualitätssicherung
Englischsprachiges Lektorat auf Muttersprachlerniveau und Sprachberatung
Zusammenarbeit mit verteilten und internationalen Teams
Eine gute technische Dokumentation beginnt mit dem Verständnis des Produkts und der Menschen, die es verwenden.
Ich formuliere nicht einfach Spezifikationen um oder übernehme lediglich Beschriftungen aus der Benutzeroberfläche. Ich untersuche die Software, verfolge die vollständige User Journey, kläre Unklarheiten mit Fachexperten und strukturiere die daraus gewonnenen Informationen anhand realer Aufgaben und Fragen.
Meine Erfahrung in der Qualitätssicherung ist dabei besonders wertvoll. Sie ermöglicht es mir, Vorgehensweisen bereits während ihrer Dokumentation zu testen, Inkonsistenzen zu erkennen, wahrscheinliche Benutzerfehler vorauszusehen und Bereiche zu identifizieren, in denen entweder die Dokumentation oder das Produkt selbst verbessert werden könnte.
Das Ergebnis ist eine technisch präzise, klar strukturierte und wirklich hilfreiche Dokumentation.
Ich stehe für freiberufliche technische Redaktion, die Modernisierung von Dokumentationen, Release-Dokumentation, Entwicklerinhalte und kurz- oder langfristige Dokumentationsprojekte zur Verfügung.
Ob Sie eine Dokumentation für ein neues Produkt, Unterstützung bei einem bevorstehenden Release oder Hilfe benötigen, um eine bestehende Dokumentationslandschaft unter Kontrolle zu bringen: Ich kann mich schnell in komplexe Software einarbeiten und daraus Informationen erstellen, mit denen Ihre Benutzer effektiv arbeiten können.
Kontaktieren Sie mich