Strukturierungsmethoden für die TD

Transkript

1 Strukturierungsmethoden für die TD Wie soll ich schreiben? tekom Regionalgruppe München 19. April 2007

2 Vorsicht - Meinung δ 2

3 Dienstleistungsfelder 3

4 Unsere Geschäftsstellen 4

5 Ausgangssituation Anforderungen an die Technische Dokumentation steigen Inhaltliche Anforderungen von Normen und Richtlinien steigen Konzeptionelle Anforderungen an die tägliche Arbeit wachsen Qualitätsanspruch an Informationsprodukte wird höher time to market wird kürzer Kostenbewußtsein und Kostendruck steigen... Handlungsbedarf besteht! 5

6 Ausgangssituation Lösungsangebote gibt es wie Sand am Meer... DITA Kontrollierte Sprache Funktionsdesign DocBook-DTD XML VDMA Informationsdesign Information Mapping Wie soll ich schreiben? Content Modelling 6

7 Ausgangssituation Wie passt das zusammen? DITA Kontrollierte Sprache Funktionsdesign DocBook-DTD XML VDMA Informationsdesign Information Mapping Content Modelling 7

8 Ausgangssituation Wie passt das zusammen? Kontrollierte Sprache?? Informationsdesign Funktionsdesign Information Mapping XML??? DITA DocBook-DTD Content Modelling VDMA

9 XML Metasprache mit weiter Verbreitung XML 1.0: W3C-Recomendation 1998 <Autor> </Autor> <Name>Ried</Name> <Vorname>Tilo</Vorname> <Firma>reinisch AG</Firma> < ></ > <xsl:for-each select= Autor > <Table> <tr><td> <p>reinisch AG</p> <p> <xsl:value of > <p></p> </p> <p> <xsl:value of > </td></tr> </p> <p> <xsl:value</table> of > </p> <p> <xsl:value of > </p> </tr></td> </Table> </xsl: for-each> XML <!ELEMENT Autor (Name,Vorname,Firma, )> HTML <Table> <tr><td> <p>ried</p> <p>tilo</p> Ried Tilo reinisch AG 9

10 XML Kritische Wertung δ! Vorteile mittlerweile hohe Verbreitung in vielen Anwendungsbereichen zunehmende Anzahl an Werkzeugen für die TD verfügbar Editoren / Datenbanken / Formatierungstools Einführungskosten sinken hat seine Leistungsfähigkeit bewiesen Nachteile erfordert Umdenken in den Redaktionen erfordert neue Tools und Programme erfordert neues Know-How / zusätzliche Konzepte erfordert teilweise immer noch hohen Aufwand bei der Einführung 10

11 Funktionsdesign Sprachwissenschaftlicher Strukturierungsansatz Prof. Jürgen Muthig und Prof. Robert Schäflein Armbruster Entwicklung der 90er Jahre Grundlagen Kommunikation ist regelbasiertes, sprachliches Handeln Eine sprachliche Aussage impliziert daher eine Funktion (Pragmatik) Diese Funktion kann in der Struktur (Syntax) der sprachlichen Handlung erkannt und optimiert werden Dies erleichtert die Vermittlung des Inhalts (Semantik) Optmierung von Texten für die Technische Dokumentation 11

12 Funktionsdesign Informationsprodukt Sequenzmuster Funktionale Einheiten Auszeichnung Betriebsanleitung, Wartungsanleitung... Handlungsanleitung, Warnhinweis... Zielangabe, Vororientierung, Resultat, Hilfe im Problemfall... Mengenangabe, technisches Datum,... Sequenzmuster Funktionale Einheiten Auszeichnung 12

13 Funktionsdesign Beispiel Sequenzmuster Handlungsanleitung Zielangabe Voraussetzung Handlungsaufforderung Handlungsaufforderung Handlungsaufforderung Handlungsaufforderung Resultatsangabe Deckeldichtung ersetzen Stellen Sie sicher, dass die neue Deckeldichtung hitzeresistent ist! 1) Öffnen Sie den Deckel 2) Entfernen Sie die alte Dichtung 3) Setzen Sie die neue Dichtung mit der roten Kontaktfläche nach oben ein 4) Schrauben Sie den Deckel von Hand ein Der Wartungszyklus ist abgeschlossen. 13

14 Funktionsdesign Webmaschine Original nach Prof. Muthig und Prof. Schäflein-Armbruster 14

15 Funktionsdesign Webmaschine Optimiert Funktionale Entflechtung Art- und Quelle der Gefahr Folgen Maßnahme Maßnahme Offenliegende, rotierende Walzen! Lebensgefahr durch Einziehen und Quetschen Enganliegende Schutzkleidung tragen Haarnetz tragen 15

16 Funktionsdesign Kritische Bewertung Vorteile an Bedürfnissen der Technischen Dokumentation ausgerichtet für weitere Bereiche anpassbar sehr flexibel und anpassbar / einfache Struktur bis komplex Werkzeugunterstützung effektiv möglich Implementierbarkeit mit XML und Werkzeuge (CMS etc.) in Deutschland hoher Verbreitungsgrad in der Lehre und in der Praxis hohe Reduktion der Textmenge möglich δ! Nachteile Schwerpunkt der Strukturbildung bei handlungsanleitenden Strukturen / beschreibende Strukturen eher flach seit 2006 als Text-/Bildmarke geschützt ( ) / zukünftige Nutzungsmöglichkeiten noch unklar Schwerpunkt der Verbreitung in Deutschland 16

17 Information Mapping Psychologischer Strukturierungsansatz R. E. Horn Entwicklung der 60er Jahre Grundlagen Orientiert an Vorstellungen über die Informationsverarbeitung im menschlichen Gehirn Berücksichtigung von Basisüberlegungen bei der Informationserstellung (Hierarchie, Gleichwertigkeit, Relevanz,...) Inhaltliche Gliederung von Informationen (Begriff, Prinzip, Prozedur, Prozess, Fakt) Einhalten von Erstellungsregeln (fünf bis neun Informationsträger in einem Text,...) bei der Informationserstellung Zusammenfügen der Informationen zu Blöcken und Maps Regeln zur Modularisierung 17

18 Information Mapping Beispiel Motoreninstallation Map Blocktitel Block Blocktitel Block Mechanische Installation Vorarbeiten Motorteile gündlich von Staub und Fett säubern. Verwendetes Lösungsmittel darf nicht in die Lager gelangen. Verwenden Sie nur folgende Lösungsmittel: - XNLS a500 SP 4 - NXLS b600 SP 3 Anflanschen der Wellen Die Welle wird mit den mitgelieferten Maschinenschrauben angeflanscht. Dabei sind die Anzungsdrehmomente wir folgt einzuhalten:... 18

19 Information Mapping Weitere Strukturen Tabellenarten Listenarten Nutzung von Abbildungen, Grafiken etc. 19

20 Information Mapping Kritische Bewertung δ! Vorteile übergreifend Nutzbar / nicht auf TD fokussiert ohne Anpassung oder Entwicklung nutzbar internationale Verbreitung Implementierbar mit XML Unterstützung durch Werkzeuge (Editoren, CMS, etc.) Reduktion der Textmenge möglich Nachteile eher geringe Strukturierungstiefe keine dezidierte Semantik vorgesehen geschützte Marke / restriktive Lizenzierung / restriktiver Informationsfluß hohe Kosten durch Lizenzierung möglich 20

21 Informationsdesign Firmenspezifischer Strukturierungsansatz (und mehr) SAP / Dorothea Denz (2001) Weitere spezifische Ausprägungen vorhanden Grundlagen Strukturierung technischer Produktinformationen in Informationsklassen Festlegung dieser Informationsklassen durch standardisierte Strukturen Vormulierungsvorgaben und Standardformulierungen 21

22 Informationsdesign Explizite und hierarchische Strukturierung Informationsklassen (Informationen gleicher Semantik) Komponente Objekt Prozess Vorgehensweise Funktion Dokumenstruktur Schlüsselabschnitte (feste Überschrift + Abschnitt) / Schemabildung Abschnitt (beantwortet eine konkrete Frage) Informationsklassen 22

23 Informationsdesign Kritische Wertung δ! Vorteile Strukturierungstiefe deckt Anforderungen der TD relativ weit ab Flexibel, wird entsprechend Anforderungen im Unternehmen entwickelt Umfassender Regelungsbereich (Struktur, Semantik, Formulierungen,...) Werkzeugunterstützung möglich Nachteile firmeninterne Methode / Verbreitung in der Praxis begrenzt Verbreitung in der Lehre begrenzt In der Anwendung und Verbreitung keine konsistente Methode 23

24 Kombinieren, wenn nötig... Information Mapping und Funktionsdesign Erhöhung der Strukturierungstiefe Bsp.: Block durch handlungsanleitende Struktur ergänzen Map Blocktitel Block Zielangabe Voraussetzung Handlungsschritt 1 Handlungsschritt 2 Handlungsschritt # Montage des Motors Welle verbinden Stellen Sie sicher dass... 1) Verschrauben Sie Welle und Flansch kreuzweise. 2) Überprüfen Sie den Anzugsdrehmoment... #)... 24

25 Semantische Strukturierung Was bedeutet semantische Strukturierung? Berücksichtigung der Bedeutung der Informationen Wiedererkennung für den Nutzer vereinfacht / Schema-Ansatz Orientierung in der Information wird vereinfacht/navigation Verständlichkeit erhöht / Erstellung vereinfacht lassen sich mit XML implementieren Theoretische Grundlagen unterschiedlich Sprachwissenschaft Psychologie Akzeptanz und Nutzung Schutz durch Registrierung Lehre an Hochschulen 25

26 Versuch einer Wertung = beste Wertung Berücksichtigung von Anforderungen der TD FD IM δ! Übergreifende Einsatzmöglichkeiten Skalierbarkeit Strukturierungswirkung/Strukturierungstiefe Wirkung in Bezug auf Textkürze Kombinierbarkeit mit Industriestandards Implementierbarkeit/Toolunterstützung 26

27 Methoden an den Hochschulen (WS 06) = voll = teilweise Donau-Universität-Krems AT Hochschule Karlsruhe FH Aalen FH Flensburg FH Gelsenkirchen FH Gießen-Friedberg FH Hannover FH Leipzig der Deutschen Telekom (Studienschwerpunkt) FH Furtwangen FH Ulm (Zusatzqualifikation) FH Merseburg FH Bonn Rhein Sieg RWTH Aachen FD IM ID 27

28 Methoden an den Hochschulen Zusammenfassung bei voller Berücksichtigung in der Lehre: bei Berücksichtigung, aber mit einschränkenden Bemerkungen: Angebotene Leistungstiefe der Hochschulen berücksichtigen keine Markierung, wenn Methode nicht berücksichtigt wird Anmerkungen 13 Möglichkeiten akademischer Ausbildung berücksichtigt Hohe Verbreitung von Funktionsdesign (9 zu 2) mehrere Anmerkungen zur lizenzrechtlichen Einschränkung bei Information Mapping ( soweit öffentliches Material verfügbar ist etc) Verbreitung von Information Mapping in der Lehre deutlich behindert (5 zu 4) Unterschiedliche Einschätzungen und Einschränkungen zum Informationsdesign. Wird in Abwandlungen weiterentwickelt und eingesetzt. Verbreitung von Infromationsdesign in der Lehre gering (5 zu 3) 28

29 DITA Darwin Information Typing Architecture 2005 als OASIS-Standard verarbschiedet Grundlagen Implementiert in XML Basiert auf Topics Maps sammeln und organisieren Topics Topics treten als Informationstypen auf Task-Topic / Concept Topic / Reference Topic / allgemeiner Topic Spezialisierung erlaubt Änderung und Anpassung von Informationstypen 29

30 DITA Task: Semantische Struktur bei DITA 30

31 DITA Kritische Wertung δ! Vorteile hoher, schnell zunehmender Bekanntheitsgrad in kurzer Zeit verfügbare, anpassbare Style-Sheets und Prozesse Starke Unterstützung durch IBM Flexibilität durch Anpassbarkeit der Informationstypen starke Unterstützung durch Werkzeuge (Editoren etc.) freie Verfügbarkeit, freie Informationen Nachteile Erfahrungsbasis in der TD (noch) überschaubar keine konsequent funktionale Strukturierung 31

32 DocBook Dokumentation für Unix Gemeinschaftsprojekt von HaL Computer und O Reilly / 1991 Wartung erfolgt durch OASIS Grundlagen Implementiert in XML Enthält umfangreiche Struktur- und Layoutelemente Herkunft und Schwerpunkt ist Papierpublikation 32

33 DocBook Kritische Wertung δ! Vorteile Ausreichende Praxiserfahrung starke Unterstützung durch Werkzeuge Flexibler Einsatz durch hohe Anzahl an Strukturen und Elementen Nachteile In der TD nicht überragend verbreitet keine funktionale / semantische Strukturierung Ergänzung: semantische Strukturierung für Softwaredokumentation sehr gut geeignet; funktionale (sprachliche) Strukturierung fehlt hohe Papierfokussierung 33

34 VDMA VDMA Einheitsblatt für den Anlagen- und Maschinenbau Standardisierung technischer Produktinformationen Grundlagen Branchenweiter Austauschstandard Einsatz von XML-Schema (XML-DTD) Enthält semantische Strukturteile nach Funktionsdesign Organisiert Informationen Objektorientiert (Funktionsobjekt, Aufbauobjekt, Handlungsobjekt, Dokumentobjekt) verknüpft diese Informationen semantisch 34

35 VDMA XML und Funktionsdesign 35

36 VDMA Einheitsblatt für den Anlagen- und Maschinenbau δ! Vorteile ermöglicht hochwertig verknüpfte Informationsstrukturen basiert auf leistungsfähigen Konzepten erlaubt Anpassung durch Ableitung der Struktur Zielt auf branchenweiten Austausch von Informationen Nachteile In der Praxis noch kein ausreichender Verbreitungsgrad relativ komplexe Struktur geringe Unterstützung durch Werkzeuge 36

37 Industriestandards Was kennzeichnet Industriestandards? Sicherheit durch weite Verbreitung und koordinierte Entwicklung teilweise leistungsfähige Unterstützung durch Werkzeuge und Tools Implementiert in XML teilweise semantische Strukturen schon implementiert ermöglichen Austausch von Informationen 37

38 Kontrollierte Sprache Standardisierung von Vokabular und Syntax AECMA Simplified English / Caterpillar Technical English /... Grundlagen Erarbeitung eines Wörterbuches (Substantive, Verben, Adjektive,...) Liste nicht zu verwendender Wörter Erarbeitung von Schreibregeln (Sicherheit, Abläufe, Beschreibung,...) Festlegen von Syntax-Regeln (Kombination von Substantiven,...) 38

39 Kontrollierte Sprache Kritische Wertung δ! Vorteile Lesbarkeit und Verständlichkeit steigen / Qualität steigt Konsistenz und Einheitlichkeit steigen / bessere Wiederverwendung Aufwand bei Lektorat und Übersetzung sinken Teilweise Nutzung möglich (Terminologie, Schreibregeln etc.) Nachteile relativ hoher Aufwand bei Entwicklung, Anpassung und Einführung Schreibprozess kann komplexer und aufwendiger werden 39

40 Content Modelling Methode zur Strukturierung von Enterprise-Content Unified Content Strategy / Ann Rockley (2003) Grundlagen Übergreifender Ansatz für alle Unternehmensinformationen Wiederverwendung von Informationen Ermöglichung von Single Sourcing expliziter Strukturierung von Inhalten Prozessfestlegung Systemnutzung und Implementierung 40

41 Content Modelling Kritische Wertung δ! Vorteile Übergreifendendes Vorgehensmodell Berücksichtigt weitgehend alle Punkte des Contentmanagements Anwendbar auf die Technische Dokumentation In den USA bekannte Methode Nachteile Bedarf zusätzlicher Aspekte der Technischen Dokumentation erfordert zusätzliches Know-How in der erfolgreichen Anwendung 41

42 Ausgangssituation Wie passt das zusammen? Kontrollierte Sprache Sprachstandard Semantische Struktur XML Informationsdesign Funktionsdesign Information Mapping Methode Content Modelling Metasprache Industriestandard ATA ispec 2200 DITA DocBook-DTD VDMA

43 Wählen Sie aus... Nutzen Sie XML... wenn Sie neue Publikationsmedien bedienen müssen wenn Sie neu anfangen δ! Nutzen Sie Funktionsdesign... wenn Sie Produktinformationen semantisch strukturieren wollen wenn Sie die Struktur an Ihre Bedürnisse anpassen wollen Nutzen Sie Information Mapping... wenn Sie für weitere Unternehmensbereiche eine Strukturierungsmethode einführen sollen Ergänzen Sie Information Mapping mit den leistungsfähigen Strukturmöglichkeiten von Funktionsdesign Nutzen Sie DITA wenn Ihnen die Topic-Orientierung ausreicht wenn Sie die vorhandenen Werkzeuge nutzen können 43

44 Wählen Sie aus... Nutzen Sie VDMA wenn Sie Informationen hochwertig verknüpft integriert nutzen wollen wenn Sie Produktinformationen in Zukunft standardisiert austauschen wollen Nutzen Sie einfache Regelungen aus Kontrollierten Sprachen.. Formulierungsfestlegungen Lexikon für Begriffe / Terminologie Nutzen Sie Überlegungen aus dem Content Modelling... Wiederverwendung von Informationen Lebenszyklus von Informationen Informationsstrukturierung δ! 44

45 ... und kombinieren Sie mutig Implementieren Sie eine semantische Struktur mit XML δ! Ergänzen Sie Industriestandards mit Elementen aus dem Funktionsdesign Legen Sie Schreibregeln und Terminologie zusätzlich zu einer semantischen Struktur fest Nutzen Sie methodische Überlegungen, die andere für Sie angestellt haben 45

46 Mehr als Technische Dokumentation. Sprechen Sie mich an!