Erstellung von Technischer Dokumentation, Softwaredokumentation und Onlinedokumentation

Ein wesentlicher Erfolgsfaktor bei Erstellen einer Technischen Dokumentation liegt darin, nicht das zu beschreiben, was Benutzer ohnehin am Produkt sehen, sondern das, was Benutzer nicht sehen. Eine gute Technische Dokumentation „beschreibt“ das Produkt nicht, sie erklärt es!

Viele meiner Kunden berate ich nicht nur, sondern übernehme für sie auch die Erstellung der kompletten benötigten Technischen Dokumentationen oder einzelner Dokumente.

Erstellung von Handbüchern und Online-Hilfen

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

Ihr Bedarf

Benötigen Sie einen Technischen Redakteur, der ein Handbuch oder eine Online-Hilfe für Sie erstellt? 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. In einfacher, verständlicher Sprache, klar strukturiert und modular aufgebaut.

Durch den Einsatz spezieller Autorensysteme ist es möglich, Benutzerhandbücher und Online-Hilfen aus einer gemeinsamen Textquelle heraus zu produzieren. Bei Bedarf sogar in unterschiedlichen Varianten, zum Beispiel für eine Lite-Version und für eine Professional-Version derselben Software. Bekannt ist dies unter den Schlagworten Cross-Media-Publishing, Multi-Channel-Publishing oder Single-Source-Publishing, 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ünden 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 generiere nach Abschluss der Übersetzung aus den übersetzten Quelldaten die benötigten Dokumente.

Erstellung von Screencasts (Software-Videos)

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

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 aufwerten? Möchten Sie Ihre Produkte anhand von Screencasts anschaulich und praxisnah demonstrieren?

Meine Dienstleistungen

Ich konzipiere und erstelle für Sie Screencasts (Software-Videos) Ihrer Produkte. Der Einsatz professioneller Erstellungswerkzeuge stellt sicher, dass:

  • die Screencasts mit geringstmöglichem Aufwand auch übersetzbar sind
  • die Screencasts bei späteren Änderungen an der gezeigten Software mit wenig Aufwand aktualisierbar sind

Was macht einen Screencast benutzerfreundlich?

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

  • Die einzelnen Videos sollten kurz sein. Ist das nicht möglich, sollten ausreichend viele 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 Schulungsunterlagen

Aus einer Technischen Dokumentation lassen sich häufig auch Schulungsunterlagen ableiten (Prinzip des Single-Source-Publishing), zum Beispiel aus einem Benutzerhandbuch 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 Technischen Dokumentation ableiten. Abhängig von den verwendeten Autorenwerkzeugen lassen sich Dokumentation und Schulungsunterlagen sogar aus denselben Quelldaten erstellen (Single-Source-Publishing).

Erstellung produktbegleitender Informationen

Übrigens: 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, zu IT-Systemen oder zu anderen erklärungsbedürftigen Produkten?

Meine Dienstleistungen

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

  • Webseiten (Internetseiten)
  • Broschüren sowie sonstige Vertriebsunterlagen und Marketingunterlagen
  • Whitepaper