Professionelle Dokumentation für professionelle Produkte

Größe: px

Ab Seite anzeigen:

Download "Professionelle Dokumentation für professionelle Produkte"

Hede Bergmann
vor 8 Jahren
Abrufe

1 Professionelle Dokumentation für professionelle Produkte Susanne Murawski, Abteilungsleiterin Joachim Pichol, Technischer Redakteur cognitas. Gesellschaft für Technik-Dokumentation Alte Landstr. 6, Ottobrunn Heinz-Nixdorf-Ring 1, Paderborn

cognitas. Gesellschaft für Technik-Dokumentation Alte Landstr.

2 Was zeichnet professionelle Dokumentation aus? Auf den ersten Blick: im Corporate Design, ansprechend, einheitlich gut gegliedert und übersichtlich Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige Zielgruppe Auf den dritten Blick: wiederverwendbar und übersetzungsfreundlich kostengünstig und in gewünschter Qualität produzierbar Folie 2 info@cognitas.de November 2003

übersichtlich Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige

3 Was zeichnet professionelle Dokumentation aus? Auf den ersten Blick: im Corporate Design, ansprechend, einheitlich gut gegliedert und übersichtlich Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige Zielgruppe Auf den dritten Blick: wiederverwendbar und übersetzungsfreundlich kostengünstig und in gewünschter Qualität produzierbar Folie 3 info@cognitas.de November 2003

4 Corporate Design Prüfen Sie, ob die gewählte Art der Darstellung zu Ihrem Unternehmen und Ihrem Produkt passt den Erwartungen der Benutzer entspricht sich in einer Dokumentation durchhalten lässt Folie 4 info@cognitas.de November 2003

den Erwartungen der Benutzer entspricht sich in einer

5 Seiten-Layout Definieren Sie Formatvorlagen, um ein konsistentes Erscheinungsbild zu erreichen. Verwenden Sie für Überschriften eine größere Schriftgröße. Stellen Sie sicher, dass eingefügte Grafiken innerhalb des Satzspiegels liegen. Folie 5 info@cognitas.de November 2003

Verwenden Sie für Überschriften eine größere Schriftgröße.

6 Anordnung von Text und Bild Überprüfen Sie, ob sich Text und Bild ergänzen. Berücksichtigen Sie die Leserichtung. Prüfen Sie, ob die Bilder (Fotos, Bildschirmabzüge, Grafiken) in guter Qualität vorliegen. Folie 6 info@cognitas.de November 2003

Prüfen Sie, ob die Bilder (Fotos, Bildschirmabzüge,

7 Gliederung Überprüfen Sie Ihre Gliederung anhand der Überschriften im Inhaltsverzeichnis. Folie 7 info@cognitas.de November 2003

8 Übersichtlichkeit Verwenden Sie Orientierungshilfen wie Seitennummerierung, Kolumnentitel, Druckregister oder Navigationsleisten. Folie 8 info@cognitas.de November 2003

9 Suchhilfen und Verweise Bilden Sie aussagekräftige Stichwörter. Vermeiden Sie Stichwörter mit vielen Seitenreferenzen. Nutzen Sie die Verweistechnik Ihres Redaktions- oder Textverarbeitungssystems. Verwenden Sie sinnvolle und genaue Verweise. Folie 9 info@cognitas.de November 2003

Nutzen Sie die Verweistechnik Ihres Redaktions- oder

10 Was zeichnet professionelle Dokumentation aus? Auf den ersten Blick: im Corporate Design, ansprechend, einheitlich gut gegliedert und übersichtlich Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige Zielgruppe Auf den dritten Blick: wiederverwendbar und übersetzungsfreundlich kostengünstig und in gewünschter Qualität produzierbar Folie 10 November 2003

Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige Zielgruppe Auf den

11 Sachliche Richtigkeit Klären Sie sämtliche Unstimmigkeiten in Ihrem Input mit den zuständigen Fachleuten. Planen Sie für die Erstellung Ihrer Dokumentation mehrere Korrekturläufe mit Fachleuten ein. Erwägen Sie die Möglichkeit eines Usability Tests mit Personen der Zielgruppe. Folie 11 November 2003

Planen Sie für die Erstellung Ihrer Dokumentation mehrere Korrekturläufe mit

12 Vollständigkeit Achten Sie darauf, dass der gesamte Funktionsumfang Ihres Produkts beschrieben ist (Instruktionspflicht). Prüfen Sie, ob alle notwendigen Sicherheitshinweise enthalten sind (Produkthaftung). Überprüfen Sie bei anweisenden Texten, ob wirklich jeder Arbeitsschritt aufgelistet ist. Folie 12 November 2003

Prüfen Sie, ob alle notwendigen Sicherheitshinweise enthalten sind (Produkthaftung).

13 Verständlichkeit (1) Denken Sie bei der Dokumentationserstellung an Ihre Zielgruppe! Gehen Sie bei Erläuterungen vom Allgemeinen zum Besonderen. Schreiben Sie Arbeitsanweisungen in der Reihenfolge des Handlungsablaufs. Erläutern Sie Fachwörter bei der Einführung oder im Glossar. Folie 13 November 2003

Schreiben Sie Arbeitsanweisungen in der Reihenfolge des Handlungsablaufs.

14 Verständlichkeit (2) Verzichten Sie auf Schachtelsätze und Satzklammern. Beispiel: Es ist nicht zu leugnen, dass die Erfahrungen, die mit dem neuen Gerät, das an die Stelle des früheren, das noch verschiedene Mängel aufwies, trat, gemacht wurden, günstig gewesen sind. Folie 14 November 2003

Gerät, das an die Stelle des früheren, das noch verschiedene Mängel aufwies,

15 Verständlichkeit (3) Schreiben Sie aktiv und benennen Sie Subjekte. Achten Sie auf sprachliche Konsistenz. Setzen Sie Layoutmöglichkeiten zur Unterstützung ein. Folie 15 November 2003

16 Was zeichnet professionelle Dokumentation aus? Auf den ersten Blick: im Corporate Design, ansprechend, einheitlich gut gegliedert und übersichtlich Auf den zweiten Blick: richtig vollständig leicht verständlich für die jeweilige Zielgruppe Auf den dritten Blick: wiederverwendbar und übersetzungsfreundlich kostengünstig und in gewünschter Qualität produzierbar Folie 16 November 2003

17 Wiederverwendbarkeit und Übersetzbarkeit Verwenden Sie möglichst viele Textbausteine. Halten Sie sich an eine festgelegte Terminologie. Vereinheitlichen Sie die Schreibweisen. Legen Sie Standardformulierungen fest. Stellen Sie Formatierungsrichtlinien auf und arbeiten Sie mit Formatvorlagen. Verwenden Sie sprachneutrale Grafiken. Optimieren Sie Ihren Text für die Übersetzung mit einem Translation-Memory-System. Folie 17 November 2003

18 Produktion Entscheiden Sie frühzeitig, wie Ihre Dokumentation veröffentlicht werden soll - als gedrucktes Buch mit oder ohne Farbe - als Hochglanz-Broschüre - als Online-Buch im Internet oder auf CD - als Online-Hilfesystem Führen Sie rechtzeitig Tests durch (z.b. Probeseiten drucken). Vermeiden Sie durch gute Planung unnötige Produktionskosten. Folie 18 info@cognitas.de November 2003

auf CD - als Online-Hilfesystem Führen Sie rechtzeitig Tests durch (z.b. Probeseiten drucken).

19 Wenn Sie doch mal Hilfe brauchen... cognitas. Gesellschaft für Technik-Dokumentation Elisabeth Schulz Heinz-Nixdorf-Ring Paderborn Claus Noack Alte Landstr Ottobrunn elisabeth.schulz@cognitas.de Tel / claus.noack@cognitas.de Tel. 089 / Folie 19 info@cognitas.de November 2003

de Elisabeth Schulz Heinz-Nixdorf-Ring 1 33106 Paderborn Claus Noack Alte Landstr.

20 Spektrum der technischen Dokumentation Print-Dokumentation Bedienhandbücher, Kurzanleitungen, Referenzhandbücher Online-Doku (onscreen = bildschirmbezogen) Handbücher am Bildschirm (verlinkte PDF-Dokumente) Hilfesysteme Lernprogramme Animierte Systeme am Beispiel des Illustrated Spares Catalogue Folie 20 info@cognitas.de November 2003

Handbücher am Bildschirm (verlinkte PDF-Dokumente) Hilfesysteme Lernprogramme

21 Spektrum der technischen Dokumentation Beispiel: Verlinktes PDF-Dokument Verweis 1 Verweis 3 Verweis 2 Folie 21 info@cognitas.de November 2003

22 Spektrum der technischen Dokumentation Beispiel: Online-Manual-Server von Fujitsu Siemens Folie 22 November 2003

23 Spektrum der technischen Dokumentation Beispiel eines Hilfesystems Folie 23 November 2003

24 Spektrum der technischen Dokumentation Beispiel eines animierten Ersatzteil-Katalogs (1) Folie 24 November 2003

25 Spektrum der technischen Dokumentation Beispiel eines animierten Ersatzteil-Katalogs (2) Vorauswahl Folie 25 November 2003

26 Spektrum der technischen Dokumentation Beispiel eines animierten Ersatzteil-Katalogs (3) kontextsensitive Fläche Folie 26 November 2003

27 Spektrum der technischen Dokumentation Beispiel eines animierten Ersatzteil-Katalogs (4) Such- Funktion Folie 27 November 2003

28 Wenn Sie doch mal Hilfe brauchen... cognitas bietet sämtliche Dienstleistungen zur Technischen Dokumentation oder full service von der Konzeption zur Produktion einzelne Bausteine, bei denen Sie Unterstützung brauchen cognitas. Gesellschaft für Technik-Dokumentation Folie 28 November 2003

Ähnliche Dokumente

Checkliste Internetpräsenz Premium Systems

Checkliste Internetpräsenz Premium Systems Diese Checkliste ist nicht für uns zu beantworten Sondern stellt nur eine Hilfe zur Klärung Ihrer eigenen Ziele dar. 1. Allgemeine Fragen: Welche Ziele sollen