Alles nur Schlagworte, wenn am Ende nicht das heraus kommt, worauf es ankommt: verständliche und nutzerfreundliche Software-Dokumentation.

Software-Dokumentation: DITA, HTML, Word, PDFSoftware-Dokumentation wird häufig mit Handbüchern, insbesondere schwer verständlichen Handbüchern, gleich gesetzt. Das mag in dem einen oder anderen Fall möglicherweise stimmen. Jedoch geht Software-Dokumentation weit über das gewöhnliche Handbuch hinaus. Software-Dokumentation ein wesentlicher Bestandteil der ausgelieferten Software, die ohne Dokumentation häufig kaum benutzt werden kann (und darf). Gute Software-Dokumentation ist kein Hexenwerk. Schritt für Schritt führt der Weg dorthin.

Analyse

  • Umfassende Dokumentationsanalyse:
    • Standardisierung und Strukturierung der Inhalte
    • Modularisierung der Inhalte
    • Navigation und Zugriffsmechanismen
    • Handlungsoriente Beschreibung der Software
    • Verwendete Informationstypen
    • Zielgruppengerechte Aufbereitung
    • Terminologiekonsistenz bezüglich der zu beschreibenden Software
    • Abgleich der Terminologie mit Style Guides (z.B. Microsoft Manual of Style)
    • Evaluation passender Tools (XML-Editoren, FrameMaker, Word, PDF, Doc-To-Help, RoboHelp usw.)
  • Analyse von Produktions- und Publikationsprozessen

Konzeption und Planung

  • Agiles Projektmanagement
  • Strukturierung und Standardisierung von Inhalten
  • Automation und Integration von Publikationsprozessen
  • Erstellen von Konzepten für das Informationsmanagement
  • Planung und Durchführung der Migration bestehender Dokumentation nach DITA (Darwin Information Typing Architecture)

Redaktion

  • Recherche und Aufbereitung von Informationen
  • Erstellung von Software-Dokumentation in englisch (bevorzugt) und deutsch
  • Erstellung von Technischer Dokumentation in Simplified English
  • Bearbeitung von Grafiken und Fotos
  • Erstellung eines Redaktionsleitfadens und Style Guides
  • Erstellung von Templates, Masterdokumenten usw.
  • Erstellung von Drehbüchern für Video-Tutorials
  • Erstellung von Training-Videos
  • Erstellung von kontextsensitiven Online-Hilfen
  • Erstellung von Schulungsunterlagen

Publikation

  • Crossmediale Verwertung der erstellten Inhalte (Print, Web, Online-Hilfen usw.)
  • Zielgruppengerichtete Verwertung der erstellten Inhalte

Referenzen

  • Atos Belgium
  • Device Insight GmbH
  • Focus Tomorrow AG
  • Fujitsu Enabling Software Technology GmbH
  • Infineon AG
  • Knorr-Bremse AG
  • Nokia Siemens Networks
  • Siemens Healthineers
  • SupplyOn AG
  • T-Mobile (Telekom Deutschland)
  • u.v.a.

Wie geht es weiter?