Erstellung von Technischer Dokumentation, Softwaredokumentation, Onlinedokumentation

Viele meiner Kunden berate ich nicht nur, sondern übernehme auch die Erstellung der benötigten Dokumente. Oder ich unterstütze meine Kunden aktiv bei bestimmten Teilaufgaben.

Erstellung von Handbüchern und Online-Hilfen

Als Dienstleister für Technische Dokumentation und Softwaredokumentation schreibe und erstelle ich Handbücher und Online-Hilfen (Onlinedokumentation, Help-Sites). Handbücher und Online-Hilfen erzeuge ich dabei in der Regel aus einer gemeinsamen Textquelle („Single-Source-Publishing“).

Ihr Bedarf

Benötigen Sie einen Technischen Redakteur, der ein Handbuch oder eine Online-Hilfe für Sie schreibt? Oder möchten Sie Ihren Kunden beides bieten: ein gedrucktes Handbuch und eine Onlinedokumentation – zum Preis von einem?

Meine Dienstleistungen

Ich erstelle für Sie alle Komponenten Ihrer Technischen Dokumentation in den benötigten Formaten – auf Deutsch oder Englisch. Alle Texte sind in einfacher, verständlicher Sprache geschrieben, klar strukturiert und modular aufgebaut.

Durch den Einsatz spezieller Autorensysteme können wir Benutzerhandbücher und Online-Hilfen aus einer gemeinsamen Textquelle heraus produzieren. Bei Bedarf sogar in unterschiedlichen Varianten, zum Beispiel für eine „Standard-Version“ und für eine „Professional-Version“ derselben Software. Bekannt ist dies unter den Schlagworten „Cross-Media-Publishing“, „Multi-Channel-Publishing“, „Single-Source-Publishing“ oder kurz „Single-Sourcing“.

Mit jedem späteren Update und mit jeder Übersetzung multipliziert sich der Nutzen. Zur Kostenersparnis kommt noch der Zeitgewinn hinzu.

Übernahme bestehenden oder zugelieferten Materials

In vielen Fällen wurden Handbücher und Online-Hilfen von Entwicklern oder vom Produktmanagement oder Marketing erstellt – oft unter erheblichem Zeitdruck. Manchmal soll dieser Weg auch zukünftig beibehalten werden, z. B. aus Kostengründern oder weil die Thematik ein sehr spezielles, nur schwer zu erwerbendes Know-how erfordert.

In diesen Fällen lektoriere, überarbeite und optimiere ich die existierenden Inhalte und mache daraus mit geringstmöglichem Aufwand eine professionelle Dokumentation auf höchstem Qualitätsniveau.

Übersetzung

Wenn Sie Ihre Dokumentation in mehreren Sprachen benötigen, vermittle ich Ihnen bei Bedarf gerne qualifizierte Übersetzer, koordiniere die Übersetzungsarbeiten und generieren nach Abschluss der Übersetzung aus den übersetzten Quelldaten die benötigten Dokumente.

Erstellung von Software-Videos (Screencasts)

Ergänzend oder alternativ zur klassischen Softwaredokumentation konzipiere und erstelle ich für Sie als Dienstleiter Software-Videos (Screencasts). Die Software-Videos lassen sich sowohl in eine Online-Hilfe einbinden als auch auf Ihrer Website verwenden.

Ihr Bedarf

Ein Bild sagt oft mehr als tausend Worte. Ein Video sagt of mehr als tausend Bilder. Möchten Sie eine Online-Hilfe mit Software-Videos (sogenannten „Screencasts“) aufwerten? Möchten Sie Ihre Produkte auf Ihrer Website oder auf YouTube anhand von Software-Videos anschaulich und praxisnah demonstrieren?

Meine Dienstleistungen

Ich konzipiere und erstelle für Sie Software-Videos Ihrer Produkte.

Software-Videos lassen sich sowohl innerhalb einer Onlinedokumentation verwenden als auch als eigenständiges Element auf einer Website. Damit erzielen Sie im Idealfall gleich einen doppelten Nutzen: Erstens dient das Software-Video Benutzern als Unterstützung bei der Bedienung Ihrer Software, zweitens dient das Software-Video als Marketing-Instrument und verschafft Interessenten auf bequeme Weise einen Einblick in das jeweilige Programm.

Der Einsatz professioneller Erstellungswerkzeuge stellt sicher, dass:

falls erforderlich die Software-Videos mit geringstmöglichem Aufwand auch übersetzbar sind

die Software-Videos bei späteren Änderungen an der Software mit wenig Aufwand aktualisierbar sind

Ein einfaches Software-Video kann als solches z. B. auch auf YouTube hochgeladen werden. Optional ist es aber auch möglich, einem Software-Video interaktive Elemente hinzuzufügen und es es damit zu einer interaktiven Demo oder zu einem interaktiven Tutorial oder Lernprogramm (E-Learning) zu machen. Auch Lernfortschrittskontrollen in Form von Aufgaben sind integrierbar.

Benutzerfreundlichkeit von Software-Videos (Screencasts)

Ein häufig vernachlässigter Punkt im Zusammenhang mit Software-Videos Screencasts ist deren Benutzerfreundlichkeit (Usability).

Die einzelnen Videos sollten kurz sein. Ist das nicht möglich, sollte eine ausreichende Anzahl an Stopp-Stellen sicherstellen, dass auch langsame Betrachter einem Software-Video folgen können – beispielsweise Personen ohne ein bestimmtes Vorwissen oder ältere Menschen.

Bei umfangreichen Screencasts sollte der Betrachter einzelne Abschnitte gezielt über ein Inhaltsverzeichnis oder über ein vergleichbares Navigationselement anwählen und wiederholen können.

Erstellung von Texten für Benutzeroberflächen (UX-Writing)

Als Spezialist für Software-User-Assistance erstelle ich für Ihre Benutzeroberfläche (User-Interface / UI / GUI) verständliche und einheitliche Texte. Darauf abgestimmt übernehme ich bei Bedarf auch die Erstellung interner und externer Hilfetexte.

Ihr Bedarf

Machen wir uns nichts vor: Benutzer stehen nicht sonderlich auf das Lesen umfangreicher Handbücher. Viele Benutzer lesen eine Dokumentation nur im äußersten Problemfall. Benutzer wollen nur eines: schnelle Ergebnisse. Viele Benutzer möchten sich auch gar nicht eingestehen, Hilfe zu brauchen.

Die beste Hilfestellung ist daher die, die der Benutzer gar nicht als Hilfe empfindet. Im Optimalfall sind Informationen einfach „da“, wenn sie gebraucht werden („Embedded Help“).

Möchten Sie Ihre Produkte mit integrierten Hilfetexten so selbsterklärend wie möglich machen?

Meine Dienstleistungen

Ich erstelle eine Lösung zur Benutzerunterstützung, die bereits weit vor der klassischen Dokumentation beginnt. Diese Lösung umfasst:

Identifikation der Informationen, die direkt in die Benutzeroberfläche (User Interface) Ihrer Software integriert werden können, anstatt sie in eine separate Dokumentation (Handbuch oder Online-Hilfe) auszulagern

Festlegung, wo und wie diese Informationen angeboten werden

redaktionelle Grundregeln (Styleguide) für alle Texte

Vereinheitlichung und Abstimmung der Begriffe (Terminologie) zwischen User Interface, Handbüchern, Online-Hilfen und Vertriebsunterlagen

redaktionelle Erstellung der Texte

Vertiefende Informationen

Für weitere Informationen zum Thema integrierte Benutzerunterstützung siehe auch meine Website www.software-user-assistance.com.

Erstellung von Schulungsunterlagen

Schulungsunterlagen lassen sich häufig aus der Technischen Dokumentation ableiten (Prinzip des Single-Source-Publishing), zum Beispiel aus einem Handbuch oder aus einer Onlinedokumentation.

Ihr Bedarf

Benötigen Sie zu Ihren Produkten neben Technischer Dokumentation auch Schulungsunterlagen?

Meine Dienstleistungen

Technische Dokumentation und Schulungsunterlagen sind zwar nicht identisch, haben aber viele Gemeinsamkeiten: In beiden Fällen müssen technisch komplexe Informationen leicht verständlich auf den Punkt gebracht werden.

Häufig lassen sich Schulungsunterlagen in weiten Teilen aus der Dokumentation ableiten. Abhängig von den verwendeten Autorenwerkzeugen lassen sich Dokumentation und Schulungsunterlagen sogar aus denselben Quelldaten erstellen (Single Source Publishing).

Erstellung produktbegleitender Informationen

Als Spezialist für komplexe technische Inhalte erstelle ich ergänzend zu Technischer Dokumentation auch verständliche und prägnante Marketing-Texte für Webseiten und Broschüren sowie Whitepaper und Fachartikel.

Ihr Bedarf

Benötigen Sie einen Texter für die Erstellung von Vertriebstexten (Marketingtexten) zu Software, zu softwaregesteuerten Produkten oder zu IT-Systemen? Benötigen Sie einen Texter, spezialisiert auf die Software-Branche und den IT-Bereich?

Meine Dienstleistungen

Ergänzend zur Technischen Dokumentation konzipiere und schreibe ich auch Texte für:

Webseiten (Internetseiten)

Broschüren und sonstige Vertrieb unterlagen und Marketingunterlagen

Whitepaper

Fachartikel

Siehe auch meine weiteren Dienstleistungen.