Dokumente analysieren

Transkript

1 Lernziele dieser Lektion Dokumente analysieren In dieser Lektion lernen Sie die Dokumentenanalyse und deren Funktionen kennen. Nachdem Sie diese Lektion vollständig erarbeitet haben, sollten Sie in der Lage sein, selbständig eine Dokumentenanalyse durchzuführen und ein Gutachten als Ergebnis der Analyse zu erstellen. Inhalt der Lektion Arten einer Dokumentenanalyse Durchführung einer Analyse Kriterien einer Analyse Beispiele Hausaufgabe bis zur nächsten Lektion Zusammenfassung Literaturhinweise Carmen analysiert Zur Arbeitsvorbereitung in der Technischen Redaktion kann auch eine Dokumentenanalyse gehören: Carmen Flinck analysiert die ursprüngliche Gebrauchsanleitung der Zitro GmbH, um die Schwachstellen aufzudecken, die zu dem Unfall von Peter Kramer geführt haben. Um Fehler und Schwachstellen in der Gebrauchsanleitung zu entdecken, geht Carmen die Dokumentation der Stichsäge Schritt für Schritt durch. Sie versucht dabei, die Anweisungen selber nachzuvollziehen und sich in den Anwender hineinzuversetzen. Auffäligkeiten hält sie schriftlich fest.

2 Außerdem untersucht Carmen die Gebrauchsanleitung im Hinblick auf Analysekriterien wie Gestaltung, Gliederung und Verständlichkeit. Besonderes Augenmerk legt sie aber auf die Sicherheitshinweise, um vermeidbare Unfälle, wie den von Peter Kramer, in Zukunft zu verhindern. Einleitung Was ist eine Dokumentenanalyse? Eine Dokumentenanalyse ist die Untersuchung eines bestehenden Dokumentes vor allem auf Fehler und Schwachstellen hin, die beseitigt werden müssen, aber auch auf positive Stellen hin, die bei einer Überarbeitung beibehalten werden sollen. Wozu eine Dokumentenanalyse? Ziel einer Dokumentenanalyse ist die Optimierung des Dokumentes. Es sollen Ansätze für eine Verbesserung des Dokumentes gefunden werden, um gravierende Fehler zu korrigieren. Arten einer Dokumentenanalyse Kurzanalyse Eine Kurzanalyse bezieht sich auf ein Einzeldokument. Sie beschränkt sich meistens auf wenige, selbstgewählte Analysekriterien und übersteigt selten einen Umfang von 3-4 DIN A4-Seiten. Oft ist eine solche Kurzanalyse die Grundlage für die Angebotserstellung durch ein Dienstleistungsunternehmen. Schwachstellenanalyse In einer Schwachstellenanalyse werden ausschließlich die verbesserungswürdigen Stellen benannt. Ausführliche Analyse Für eine ausführliche Analyse wird eine umfangreiche Kriterienliste erstellt, nach der das Dokument beurteilt werden wird. Anerkannte Organisationen (z.b. tekom oder VDI) haben bereits Kriterienlisten entworfen, die als Leitfaden eingesetzt werden können. Literaturhinweis: tekom - Gesellschaft für technische Kommunikation (Hrsg.): Technische Dokumentation beurteilen. Redaktion: Christa Hülk, Claus Noack. Stuttgart o.j. (zu bestellen über Publikationen / Preisliste)

3 Durchführung einer Dokumentenanalyse Vorbereitung Um eine Basis für eine Dokumentenanalyse zu schaffen, sollten zuerst folgende Fragen beantwortet werden: Welcher Gegenstand wird dokumentiert? Um welche Art Dokument handelt es sich? Welchen Zweck hat das Dokument? Welche Informationen und welche Kenntnisse soll es vermitteln? Wer sind die Adressaten des Dokumentes? Werden diese Fragen beantwortet, erhält man grundlegende Informationen, die bei der Analyse von Dokumenten Einfluß nehmen und gleichzeitig hilfreich bei der Beurteilung sind. So wird festgestellt, unter welchem Gesichtspunkt und Hintergrund das Dokument zu analysieren ist. Ausführung Das Dokument wird anhand bestimmter Kriterien analysiert. Folgende stehen dabei zur Auswahl: Äußere Form und Ausführung Orientierungshilfen und Verzeichnisse Gestaltung Gliederung Text Abbildungen Sicherheitshinweise Gesetze, Normen, Regeln und Richtlinien Diese Kriterien sollen nur als Anhaltspunkte dienen. Einzelne Punkte der Liste können ausgewählt oder weitere ergänzt werden. Ergebnis Als Ergebnis der Dokumentanalyse wird ein Gutachten erstellt. Der Aufbau eines Solchen könnte wie folgt aussehen: 1. Titelblatt mit Angaben zum Dokument, Autor und Gegenstand der Analyse. 2. Inhaltsverzeichnis mit allen im Dokument zu findenden Informationen. 3. Angaben zum Gegenstand der Analyse und zur Vorgehensweise. 4. Darstellung der einzelnen Analysekriterien. 5. Darstellung der Analyseergebnisse gestaffelt nach den unterschiedlichen Analysekriterien, ggf. mit Zusammenfassungen, Einzelstellungnahmen und Optimierungsvorschlägen. 6. Umfassende Stellungnahme zum analysierten Dokument. 7. Falls notwendig ein Anhang mit ausführlichen Optimierungsvorschlägen. In dem Gutachten sollten nicht nur Schwachstellen des Dokumentes benannt, sondern auch die positiven Aspekte hervorgehoben werden.

4 Kriterien einer Dokumentenanalyse Äußere Form und Ausführung Das Material der Dokumentation muß für den späteren Anwendungsbereich, die Umgebung und die Zielgruppe geeignet sein. Besonderer Bedeutung kommt der Papierqualität zu. Ein Werkstatthandbuch für eine Autowerkstatt muß z. B. aus ölbeständigem und stabilem Papier bestehen, die Anleitung einer Küchenmaschine sollte im Idealfall abwaschbar sein. Die Art und Weise der Bindung sollte einen stabilen Eindruck machen und für Langlebigkeit sorgen. Das Format der Gebrauchs- oder Betriebsanleitung muß im richtigen Verhältnis zum Produkt stehen. Eine Anleitung im DIN A4-Format paßt genauso wenig zu einer Armbanduhr wie eine»daumenkino«-anleitung im Miniformat zu einem Videorecorder. Äußere Form und Ausführung sollten nicht zu aufwendig sein (Kosten), den Anforderungen aber entsprechen, so daß sich die Dokumentation nicht zu schnell abnutzt. Orientierungshilfen und Verzeichnisse Die wichtigsten Orientierungshilfen sind Inhaltsverzeichnis, Stichwortverzeichnis, Randmarken und Kolumnentitel. Notwendige Orientierungshilfen müssen vorhanden und vollständig sein. Besonders wichtig ist die Funktionalität der Orientierungshilfen, sie müssen exakt und ohne Umwege zur referenzierten Textstelle führen. Orientierungshilfen und Verzeichnisse sollten dem Leser helfen, sich im Dokument besser und schneller zurechtzufinden. Gestaltung Eine gute Gestaltung verbessert die Lesbarkeit des Dokumentes. Die Gestaltung eines Dokumentes bezieht sich auf: Typographie (Schriftart, Schriftgröße, Schriftfamilien) Seitenlayout (Gesamteindruck der Seite, Anordnung von Text und Bild, Lesefluß) Satzspiegel (Spaltenaufteilung, Seitenränder) Gliederung Die Struktur des gesamten Dokumentes und die Struktur der einzelnen Texte, Kapitel und Absätze werden auf ihren logischen Aufbau hin untersucht, dabei wird zwischen der»inneren Ordnung«und der»äußeren Ordnung«unterschieden. Die innere Ordnung bezieht sich auf die grammatikalische Ebene der Textstruktur. Die äußere Ordnung bezieht sich auf die thematische Ebene der Textstruktur. Untersucht werden bei dem Analysekriterium»Gliederung«: eine sinnvolle Reihenfolge der Sätze im Text. eine sinnvolle, klare Gliederung des Textes in Absätzen. eine thematisch sinnvolle und klare Einteilung des Textes in Kapitel. Text Dem Text sollte große Aufmerksamkeit geschenkt werden. Beurteilt werden sollte er nach folgenden Punkten: Rechtschreibung und Zeichensetzung Wortebene (z. B. Grammatik, Einheitlichkeit der Terminologie) Satzebene (z. B. Satzbau/Syntax, Grammatik, Pragmatik) Textebene (z. B. Abschnittbildung, Übergänge, Bezüge) Verständlichkeit (auf allen Ebenen)

5 Abbildungen Mit Abbildungen können Texte ergänzt oder ersetzt werden. Für gleiche Informationen muß immer das gleiche Symbol verwendet werden. Text und Abbildung müssen inhaltlich und von der Plazierung her zusammenpassen. Nicht die Quantität, sondern die Qualität der Abbildungen ist entscheidend. Abbildungen sollten immer eine Bildunterschrift oder eine Numerierung vorweisen, so daß im Text eindeutig auf sie verwiesen werden kann. Sicherheitshinweise Der bestimmungsgemäße sowie der bestimmungwidrige Gebrauch des Produktes muß eindeutig geklärt sein. Sicherheitshinweise müssen an der richtigen Stellen stehen, also am Anfang des Dokumentes und an den notwendigen Stellen innerhalb des Textes. Sie müssen deutlich und auffällig gekennzeichnet sein, so daß sie sofort ins Auge fallen, möglichst mit einem Warnsymbol (entsprechend der Art der Gefahr) und Signalwort versehen sein. Die Formulierung muß eindeutig sein, auf die bestehende Gefahr muß ausreichend und deutlich hingewiesen werden. Gesetze, Normen, Regeln und Richtlinien Bei der Herstellung eines Gerätes, einer Maschine oder eines anderen technischen Produktes ist der Hersteller aus strafrechtlichen und auch betriebswirtschaftlichen Gründen dazu gezwungen, einschlägige Gesetze, Normen und Richtlinien einzuhalten. Bei einer Überprüfung auf Normenkonformität muß untersucht werden, ob die speziell für das Produkt geltenden Normen und Richtlinien in der Dokumentation umgesetzt worden sind. Überprüft werden muß außerdem, ob Normen und Richtlinien technischer Dokumentationen berücksichtigt wurden (VDI 4500, tekom Richtlinie: Technische Dokumentation beurteilen, DIN V 8418, DIN V 66055, ANSI Z535). Beispiele Hier können Sie sich ein Beispiel einer Kurzanalyse und einer ausführlichen Analyse ansehen. Die Analysen werden nur ausschnittsweise wiedergegeben, sollten Ihnen aber eine Vorstellung davon vermitteln, wie eine jeweilige Analyse aussehen kann. Kurzanalyse zum Downloaden Ausführliche Analyse zum Downloaden Zur Betrachtung dieser Datei benötigen Sie den Adobe Acrobat Reader. Dieser steht in der Hilfe zum Herunterladen zur Verfügung. Hausaufgabe bis zur nächsten Lektion. 1 Führen Sie eine Kurzanalyse der Gebrauchsanleitung für die Stichsäge ZITRO STE 500 / STE 600 SE durch. Gehen Sie in der Kurzanalyse auf alle Stellen ein, die Ihnen bei der gründlichen Durchsicht des Dokumentes als verbesserungswürdige Stellen auffallen. Stellen Sie das Ergebnis Ihrer Kurzanalyse in Form eines kurzen Gutachtens dar.

6 2. Formulieren Sie zum Abschluß auch ein Begleitschreiben, mit dem Sie das Ergebnis der Kurzanalyse der Firma ZITRO vorstellen. Gebrauchsanleitung ZITRO STE 500 / STE 600 SE zum Downloaden Zusammenfassung In dieser Lektion haben Sie gelernt, welche verschiedenen Arten von Dokumentenanalysen es gibt, wie eine solche Analyse durchgeführt werden sollte und nach welchen Kriterien eine Dokumentation beurteilt werden kann. Sie sollten nun in der Lage sein, anhand der gegebenen Information und Beispiele selbständig eine Dokumentenanalyse durchzuführen. Literaturhinweise tekom-richtlinie: Technische Dokumentation beurteilen Die tekom - Gesellschaft für technische Kommunikation e. V. mit Sitz in Stuttgart hat im Jahre 1991 eine Richtlinie mit dem Titel»Technische Dokumentation beurteilen«veröffentlicht. Diese Richtlinie soll zur Qualitätsverbesserung Technischer Dokumentation in Deutschland führen. Sie gibt Fachleuten im Bereich Technische Dokumentation Hilfsmittel an die Hand, um eine Technische Dokumentation hinsichtlich Sprache, Struktur und Gestaltung zu untersuchen. Die Einhaltung dieser Richtlinie wird empfohlen, ist aber nicht zwingend. VDI 4500 Der Verein Deutscher Ingenieure (VDI) hat Ende 1994 die Richtlinie VDI 4500»Technische Dokumentation. Benutzerinformation«verabschiedet. Diese Richtlinie möchte nicht nur Informationen zur Bewertung von Technischer Dokumentation weitergeben, sondern ist ein umfassender Ratgeber für die Erstellung von Benutzerinformationen. Neben den Kapiteln über die eigentliche Erstellung beinhaltet die Richtlinie z.b. Kapitel über die organisatorischen Voraussetzungen und den betriebswirtschaftlichen Aspekt der Technischen Dokumentation. - Web-Adresse: Dateiname:l_doku-analyse.htm - Bearbeitungsstand: Mittwoch, 1. August 2001, 15:52 Uhr - Feedback: Rolf Schwermer