|
Know-how zur Technischen Dokumentation
|
|
|
Know-how, Checklisten, Tools und Links zum Thema Software-Dokumentation. Diese Informationen sollen Ihnen helfen, wenn Sie selbst verständliche Handbücher, Online-Hilfen, Demos und Tutorials erstellen möchten.
Möchten Sie Ihre Technische Dokumentation selbst schreiben?
Hier finden Sie Grundlagenwissen, Checklisten, Tools und Links, die Ihnen beim Schreiben benutzerfreundlicher Handbücher, Online-Hilfen, Software-Demos, Tutorials und anderer Formen der Benutzerunterstützung ("User Assistance") helfen.
User Assistance muss die Lücke überbrücken, zwischen dem was der Anwender schon weiß, und dem, was er noch nicht weiß.
Viele Verantwortliche glauben, das Erstellen Technischer Dokumentation sei eine vergleichsweise einfache Arbeit, die keine spezielle Qualifikation erfordert und problemlos an einen der beteiligten Entwickler delegiert werden kann, oder gar an einen Praktikanten. Von der technischen Seite her mag dies in vielen Fällen tatsächlich zutreffen. Geeignete Autorensoftware erzeugt auf Knopfdruck hübsch anzusehende Handbücher und Online-Hilfen. Wenn Sie also nur ein Ergebnis brauchen, das gut aussieht, ist dies der richtige Weg.Von der didaktischen Seite her, ist die Herausforderung jedoch ungleich größer. Haben Sie sich schon einmal gefragt, warum so viele Menschen Handbücher nur höchst ungern lesen und bei der Bedienung so vieler Produkte frustriert scheitern? Dies passiert immer dann, wenn die Dokumentation nicht die Arbeitsweise und Denkweise der Benutzer widerspiegelt.
Gute Entwickler sind meist schlechte Technische Redakteure. Unterbewusst gehen sie davon aus, dass Benutzer ein ähnliches Vorwissen mitbringen, wie sie selbst, und dass Benutzer denselben Denkmustern folgen, wie sie selbst. Ergebnis: Dokumentation "von Entwicklern für Entwickler", jedoch schwer verständlich für Benutzer. Selbst wenn Sie sich dem Problem voll bewusst sind, ist es nahezu unmöglich, diesem Effekt zu entgehen.
Ein erfahrener Technischer Redakteur kann dabei helfen, die Lücke zwischen dem Wissen und der Denkweise der Entwickler einerseits, und dem Vorwissen und der Denkweise der Benutzer andererseits zu überbrücken (siehe Bereich Dienstleistungen).
|
Die folgenden Checklisten können Ihnen bei den ersten Schritten Ihres Projekts helfen:
| ▪ | Auswahl eines Autorensystems
Zeigt, worauf Sie bei der Auswahl eines geeigneten Erstellungswerkzeugs für Ihre Technische Dokumentation achten sollten, damit diese Lösung optimal zu Ihren spezifischen Anforderungen passt und auch auf Dauer effizient und zukunftssicher bleibt. |
| ▪ | Auswahl eines Screen Capture Tools
Zeigt, worauf Sie achten sollten, wenn Sie nach einer speziellen Software zum Erstellen und Nachbearbeiten von Bildschirmfotos ("Screenshots" / "Screen Captures") suchen. |
| ▪ | Auswahl eines Screencasting Tools
Zeigt, welche Kriterien Sie bei der Auswahl einer Software zur Erstellung interaktiver Software Demos ("Screencasts") berücksichtigen sollten. |
|
Die folgenden Tools unterstützen Sie beim Erstellen von Handbüchern ("Bedienungsanleitungen" / "Betriebsanleitungen"), Online-Hilfen, Software-Demos und anderen Formen der Technischen Dokumentation und User Assistance:
|
Wenn Sie Technische Dokumentation schreiben oder anderweitig in ein Projekt zur Benutzerunterstützung eingebunden sind, helfen Ihnen vielleicht auch die folgenden Quellen weiter:
|
Schlüsselwörter zu dieser Seite: Technische Dokumentation - Technische Kommunikation - Software-Dokumentation - Softwaredokumentation - Software User Assistance - Benutzerdokumentation - Handbuch - Handbücher - Benutzerhandbuch - Benutzerhandbücher - Online-Hilfe - Online-Hilfen - Onlinehilfe - Onlinehilfen - Benutzerdokumentation - erstellen - Erstellung - schreiben - verfassen - Entwicklung - entwickeln - Know-how - Grundlagen - Informationen - Infos - Tipps - Quellen - Software - Tools - Vorlagen - Formatvorlagen - Templates - Verständlichkeit - verständlich - Benutzerfreundlichkeit - benutzerfreundlich - Anwenderfreundlichkeit - anwenderfreundlich.
|
|
|
|
|
 |
Willkommen bei indoition engineering,
Ingenieurbüro für Technische Dokumentation und Software-User-Assistance-Lösungen.
|
Hier finden Sie
Know-how,
Arbeitshilfen,
Dienstleistungen
zur Erstellung von
Handbüchern,
Online-Hilfen,
Demos und Tutorials,
Texten für Benutzeroberflächen,
Texten für Websites und Broschüren.
|
| Ein Service von indoition engineering Marc Achtelig – Dienstleister für Technische Kommunikation, Spezialist für Software-Dokumentation, Experte für Online-Hilfen und Single Source Publishing. |
 |
Intro zeigen (80 Sek.):  |
|
|
