Konzeption neuer Dokumentation

Als Dienstleister für Technische Dokumentation erstellen wir Konzepte für verständliche, benutzerfreundliche Software-Dokumentation, wie Handbücher, Online-Hilfen, Screencasts, Demos und Tutorials. Bei Bedarf übernehmen wir anschließend gerne auch die Erstellung der einzelnen Dokumente.

Haben Sie ein neues Produkt oder eine neue Software entwickelt? Benötigen Sie dazu noch Benutzerdokumentation, wie Handbücher oder Online-Hilfen?

Auf Basis einer eingehenden Zielgruppenanalyse erarbeiten wir einen konkreten Realisierungsvorschlag für die Technische Dokumentation und User Assistance zu Ihrem Produkt – von den didaktischen Grundlagen bis hin zum detaillierten Gliederungsentwurf.

Ein Hinweis gleich vorweg: Durch die konsequente Ausrichtung auf Ihre Zielgruppe entsteht mit großer Wahrscheinlichkeit nicht die Lösung, die Sie persönlich bevorzugen würden – denn Sie gehören nicht zur Zielgruppe und verfügen über spezifisches Vorwissen, über das Ihre Kunden nicht verfügen.

Optional übernehmen wir nach Abschluss des Konzepts gerne auch die Redaktion und Produktion der entwickelten Lösung oder unterstützen Sie bei der Umsetzung.

Kann ein professioneller Technischer Redakteur nicht auch einfach ohne vorgeschaltete Konzeptionsphase mit dem Schreiben beginnen und die Dokumentation gewissermaßen „simultan“ entwickeln? Natürlich ist das möglich, aber es wird am Ende immer der teurere und langwierigere Weg werden. Warum?

Im Laufe jedes Projekts sind viele Entscheidungen zu treffen. Diese Entscheidungen können im Rahmen eines vorgeschalteten Konzepts erfolgen oder erst unmittelbar beim Schreiben der Texte. Beides dauert gleich lange.
Bis hier ist also noch kein Gewinn an Zeit und Kosten durch ein vorgeschaltetes Konzept erkennbar, allerdings auch kein Verlust.
Viele Entscheidungen bedingen sich gegenseitig. Daher müssen später immer einige der zu Beginn getroffenen Entscheidungen wieder rückgängig gemacht werden.
Solange Sie noch am Konzept arbeiten, kostet die Rücknahme einer Entscheidung nichts: Sie müssen lediglich Ihre Meinung ändern, das ist alles. Wenn jedoch schon mit dem Erstellen der Dokumentation begonnen wurde, wird es teuer. Sie müssen alles bis zu diesem Zeitpunkt Erstellte wieder überarbeiten. Je mehr schon existiert, desto teurer wird es.

Beantworten Sie nun die Frage bitte selbst, was am Ende der sicherere, kostengünstigere und schnellere Weg ist. …

Ein solides Dokumentationskonzept muss nicht umfangreich sein, sollte aber zumindest folgende Fragen beantworten:

Anforderungen der Zielgruppe
Über welches Vorwissen verfügen Ihre Kunden bereits? Wie sind ihre Arbeitsabläufe? Was sind ihre primären Ziele und Aufgaben?
Weitere zwingende Anforderungen
Welche fundamentalen Rahmenbedingungen sind zu berücksichtigen, wie z.B. Termine, Budget, Häufigkeit zukünftiger Überarbeitungen, Übersetzbarkeit. Muss sich die neue Dokumentation in ein bestimmtes Schema bereits existierender Dokumente einfügen? Im Falle von Software: Welches Betriebssystem und welche Programmiersprache werden verwendet, welche Browser sind auf den Computern der Benutzer verfügbar? Im Falle von Software auf mobilen Geräten oder Operator Panels an Maschinen: Welche Bildschirmauflösung steht zur Verfügung? Gibt es eine Maus und eine vollwertige Tastatur?
Informationstypen
Welche Art von Informationen benötigen Ihre Kunden: Allgemeine Grundlageninformationen, detaillierte Referenzinformationen, schrittweise Anleitungen? Muss auch allgemeines Domänenwissen über das Umfeld der Anwendung vermittelt werden oder reicht die reine Beschreibung der Produktbedienung?
Medien
Wird es ein gedrucktes Handbuch (PDF), eine kontextsensitive Online-Hilfe oder beides geben? Welche Informationen kommen ins Handbuch, welche in die Online-Hilfe?
Dokumente
Welche Dokumente werden erstellt? Kommen alle Informationen in ein einziges Dokument oder werden verschiedene Handbücher für unterschiedliche Anwendungszwecke und Benutzergruppen vorgesehen?
Hilfe-Formate / kontextsensitive Hilfe-Aufrufe
Welches Hilfe-Format wird verwendet? Standard HTML oder ein spezielles Hilfe-Format? Können kontextsensitive Hilfe-Aufrufe vorgesehen werden? Wer weist die erforderlichen Hilfe-IDs zu: Programmierer oder Hilfe-Autor?
Navigation
Welche Navigationselemente sollen in den Dokumenten und Hilfen vorgesehen werden? Wo sind Links / Querverweise sinnvoll, wo nicht?
Struktur / Gliederung
Wie sollen die Dokumente strukturiert werden? Welche Kapitel / Topics sind vorzusehen?
Erstellung / Produktion
Welche Erstellungswerkzeuge werden verwendet? Können dieses Werkzeuge auch alle heute und in Zukunft benötigten Fremdsprachen handhaben?

Darüber hinaus kann das Konzept optional auch noch Beispiel-Layouts und einfache Prototypen umfassen.

 

 

Gerne erstellen wir Ihnen ein individuelles Angebot. Unsere Kontaktdaten finden Sie hier.

Schlüsselwörter zu dieser Seite: Technische Dokumentation - Technische Dokumentation erstellen - Software-Dokumentation - Softwaredokumentation - Benutzerdokumentation - Doku - Handbuch - Handbuch erstellen - Benutzerhandbuch - Benutzerhandbuch erstellen - Online-Hilfe - Online-Hilfe erstellen - Onlinehilfe - Onlinehilfe erstellen - Konzeption - Konzept - Dokumentationskonzept - Dokumentations-Konzept - Informationsdesign - Informationskonzept - konzipieren - Entwurf - entwerfen - Design - Entwicklung - entwickeln - Verständlichkeit - verständlich - Benutzerfreundlichkeit - benutzerfreundlich - Anwenderfreundlichkeit - anwenderfreundlich - gut.

 

Impressum | Copyright | Nutzungsbedingungen | Links auf unsere Seiten | Danksagung

Newsfeed abonnieren Newsfeed

Bookmark and Share
Software-Dokumentation
seit 1989.
Zahlreiche Fachvorträge und Publikationen zum Thema Technische Dokumentation und Software User Assistance.
Goldene Diskette des Computermagazins CHIP.
Mitglied im deutschen Fachverband für Technische Kommunikation und Informationsentwicklung.
Intro zeigen (80 Sek.):  Abspielen