|
Ihr Bedarf
Haben Sie ein neues Produkt oder eine neue Software entwickelt und benötigen dazu Benutzerdokumentation wie z.B. Handbücher oder Online-Hilfen?
Meine Leistung
Auf Basis einer eingehenden Zielgruppenanalyse erarbeite ich einen konkreten Realisierungsvorschlag für Ihre Dokumentation Ihres Produkts – von den didaktischen Grundlagen bis hin zu einem detaillierten Gliederungsentwurf. Bei Online-Hilfen und Software-Demos gehört in der Regel auch ein einfacher Prototyp zum Konzept dazu.
Ein Hinweis gleich vorweg: Durch die konsequente Ausrichtung auf Ihre Zielgruppe entsteht mit großer Wahrscheinlichkeit nicht die Lösung, die Sie selbst bevorzugen würden – denn Sie gehören nicht zur Zielgruppe und verfügen über spezifisches Vorwissen, über das Ihre Kunden noch nicht verfügen. Wie ein guter Anzug kann eine gute Dokumentationslösung niemals für jedermann gleichzeitig maßgeschneidert sein. Wichtig ist, dass sie Ihren Kunden passt. Dann sind Ihre Kunden glücklich, und Sie sind es auch.
Optional übernehme ich nach Abschluss des Konzepts gerne auch die Redaktion und Produktion der entwickelten Lösung oder unterstütze Ihre eigenen Mitarbeiter bei der Umsetzung.
Viele Verantwortliche fragen sich, ob ein Dokumentationskonzept überhaupt erforderlich ist. Kann ein professioneller Technischer Redakteur nicht auch einfach so 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, hängen also voneinander ab. 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 Zurü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 selber, was am Ende der sicherere, kostengünstigere und schnellere Weg ist...
|
Ein solides Konzept muss gar nicht besonders 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 wird verwendet, welche Browser sind auf den Computern der Anwender verfügbar? Im Falle von Software auf mobilen Geräten oder Operator Panels an Maschinen im industriellen Umfeld: Welche Bildschirmauflösung steht zur Verfügung? Gibt es eine Maus und eine vollwertige Tastatur? |
| ▪ | Medien
Wird es ein gedrucktes Handbuch (pdf) oder eine kontextsensitive Online-Hilfe geben oder beides? Welche Informationen kommen ins Handbuch, welche in die Online-Hilfe? |
| ▪ | Hilfe-Formate / kontextsensitive Hilfe-Aufrufe
Welches Hilfe-Format wird verwendet? Standard HTML oder ein kompiliertes Hilfe-Format? Können kontextsensitive Hilfe-Aufrufe vorgesehen werden? Wer weist die Hilfe-IDs zu: Programmierer oder Hilfe-Autor? |
| ▪ | Dokumente
Welche Dokumente werden erstellt? Kommen alle Informationen in ein einziges Dokument oder werden verschiedene Handbücher für unterschiedliche Anwendungszwecke und Benutzergruppen vorgesehen? |
| ▪ | 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? |
| ▪ | Navigation
Welche Navigationshilfen sollen in der Online-Hilfe vorgesehen werden? Wo werden Links / Querverweise angeboten und wo nicht? |
| ▪ | Struktur / Gliederung
Wie sollen die Dokumente strukturiert werden? Welche Kapitel / Topics sind vorzusehen? |
| ▪ | Erstellung / Produktion
Welches Autorenwerkzeug wird verwendet? Kann dieses Werkzeug alle heute und in absehbarer Zukunft benötigten Fremdsprachen handhaben? |
Darüber hinaus kann das Konzept optional auch noch ein Beispiel-Layout und einen einfachen Prototypen einer Online-Hilfe oder Software-Demo umfassen.
|
Siehe auch
Formatvorlagen (Templates)
Handbücher und Online-Hilfen aus gemeinsamer Textquelle
Interaktive Software-Demos und Tutorials
Unterstützung bei der Auswahl von Autorensystemen
Workshops / Coaching / Mentoring
|
