Home

PDF-Version - FB IKS - Hochschule Merseburg

1. ber Festlegungen von Metadaten in Maps kann ebenfalls nur der Verarbeitungs prozess elektronischer Dokumente gesteuert werden 6 4 Werkzeuge f r DITA Mit dem DITA Standard wird das DITA Open Toolkit zur Verf gung gestellt Es ist Java basiert und somit auf den Plattformen Microsoft Windows Linus Unix und MAC OS einsetzbar Mit dem DITA Open Toolkit k nnen aus DITA strukturierten Inhalten Ausgabemedien wie HTML XHTML HTML Help JavaHelp PDF EclipseHelp DocBook Troff und RTF generiert werden vgl Fritz et al 2008 S 22 Zudem werden die Verarbeitung spezialisierter Informationsstrukturen und die bedingte Verarbeitung Abschnitt 6 3 2 Metadaten f r die Verarbeitung der DITA 50 XML Dateien um Inhalte zu filtern oder zu kennzeichnen erm glicht vgl Hentrich 2008 S 30 Das DITA Open Toolkit enthalt folgende Bestandteile DITA DTDs und XML Schemadateien XSLT Stylesheets zur Transformation in verschiedene Ausgabeformate ANT Build Dateien Another Neat Tool steuert automatische Produktion der Ausgabemedien dost jar Datei enth lt Java Klassen f r die Generierung in entsprechende Ausgabemedien Beispieldateien DITA Dokumentation F r die Installation wird das Java Development Kit ben tigt um die erforderliche Java Umgebung f r das DITA Open Toolkit bereitzustellen vgl Hentrich 2008 S 262 Das vollst ndige Paket stellt zum eigentlichen DITA Open Toolkit weitere Programme
2. sondern aus einer gemeinsamen Quelle beziehen 70 Diese Methode bzw zentralen Module werden in den Fachkreisen als Reuse Pool bezeichnet vgl Ziegler 2007 S 23 Reuse Pool Abbildung 26 Verwenden von Informationen aus einem gemeinsamen Reuse Pool Die Sicherheitshinweise allgemeine und spezifische wurden ebenfalls in einem separat gekennzeichneten Sammeldokument SCH_safety_precautions xml erfasst Sie k nnen somit in einem zentralen Dokument bearbeitet und anhand von Metadaten verwaltet werden Diese Entscheidung wurde getroffen nach dem die einzelnen Topics mit Sicherheitshinweisen anhand der Dateibezeichnung im Dateiverzeichnis nicht mehr identifiziert werden konnten DITA unterst tzt das beziehen aus einer Quelle mit dem conref Mechanismus Abschnitt 6 1 4 Kombination der Topics Die Inhalte werden dann an den entsprechenden Stellen referenziert 7 1 3 Festlegungen zur Dateibezeichnung Um gezielt auf ben tigte Inhalte zugreifen zu k nnen m ssen die Topics von den Technischen Redakteuren eindeutig identifiziert werden k nnen insbesonders wenn die Topics im Dateisystem verwaltet werden Im Folgenden wird eine M glichkeit vorgestellt die f r das Benutzerhandbuch angewendet wurde Bei der Festlegung wurden die Inhalte zum einem nach Informationsprodukt klassifiziert und zum anderen nach den Inhalten 71 Entsprechend dem Informationsprodukt werden die Inhalte in einer handlun
3. Vor der Handlungssequenz wird dem Anwender mitgeteilt welche Werkzeuge er f r die Aufgabe ben tigt Tools and materials und welche Vorberei tungen getroffen werden m ssen Preparation Darauf folgen eine oder mehrere Handlungssequenzen Die Handlungsschritte sind in chronologischer Reihenfolge angeordnet Nach den Handlungssequenzen folgen die abschlie enden Arbeiten Final activity 2 1 Connection of coupler halves Two cars equipped with semipermanent coupler halves are connected as follows Tools and materials e Torque wrench e Hammer BD nun Preparation 1 Make sure that the centring bush of the coupler half is properly aligned with the centring cone of the mating coupler half 2 Visually check the coupler halves for damage ee Connecting the coupler halves 1 Slowly drive the cars together ensuring that the coupler halves are close together 2 Place upper muff 3 on the collars of the coupler shanks and introduce new hexagon head screws 1 into the bores 3 Final activity 1 Check the air pipe connection for leakage no hissing noise Abbildung 24 Auszug aus einer Handlungssequenz 68 Auf das Ebenenmodell des Funktionsdesigns bertragen stellen die Informations elemente Funktionalen Einheiten Tools and materials Preparation Connection the coupler halves und Final activity ein Sequenzmuster Handlungssequenz dar die in einer handlungslogischen Reihenfolge angeordnet sind und f r das gesa
4. blau der Texteinsch be und einer Verweisverwaltung durch die FM eigene Funktion nderungsverwaltung unterst tzt Die DITA Verweisverwaltung wird in Kapitel 7 3 1 Erstellen der Topics ausf hrlicher beschrieben Die DITA Anwendungen werden im Modus Strukturierte Anwendung von FM ber das Men DITA zur Verf gung gestellt 56 E Adobe FrameMaker Strukturiert ojis s ten Element Format Darstellung Spezial Grafik Tabelle Strukturierungswerkzeuge DITA Fenster Hilfe erbenalysarnl errTrr e zuls ss sasale I I Topkref er FM DITABook aus DITA Map Datei erstellen FM Dokument aus DITA Map erzeugen DITA Optionen Generate Output Abbildung 15 Ansicht im Strukturierten FrameMaker Uber das Men k nnen dann DITA Topics und Maps FM Dokumente und B cher erstellt werden Eine einfache Erstellung der DITA Dateien wird durch die Strukturansicht und den Elementekatalog erm glicht T Datei Bearbeiten Element Format Darstellung Spezial Gra Tabelle Strukturierungswerkzeuge DITA Fenster Hilfe ej orbonak Aonn soc W e mb aR AFTE eals s aSsp reso v Mrina Po xo a Be A topicam lt gt TOPIC TITLE FE e g55 3 I gt TOPIC TITLE i i 4 4444444444444466 ii g x i i SMBR4ABATT Dok topic xml Textflu 100 Z Textfluss A E title fi von 1 100 z Z gt Abbildung 16 Ele
5. r den Import Export Structured API Client Application Programming Interface Jede DITA Anwendung hat eine Anwendungsdefinition die auf ihre Dateien verweist Im folgenden Abschnitt werden die Bestandteile der DITA Anwendungen n her beschrieben Die Lese Schreibregeln und das XSLT Stylesheet werden f r diese Arbeit nicht ver ndert und sollen im Einzelnen nicht weiter erl utert werden Die M glichkeiten des Structured API Clients w rden den Funktionsumfang der Anwendungen erweitern beispielsweise die Anpassung von spezialisierten Informationsmodellen setzen aber Programmierkenntnisse voraus Aus diesem Grund wird auf dieses Thema ebenfalls nicht weiter eingegangen 59 Anwendungsdefinitionen Die Anwendungsdefinitionen der DITA Anwendungen sind zentral in der Datei structapps fm gespeichert die sich im Unterverzeichnis Structure von FrameMaker befindet Die Datei selbst enth lt insgesamt 21 vordefinierte Strukturanwendungen die beim Import und Export von XML SGML zur Verf gung stehen Die structapps fm kann im FrameMaker Strukturiert ber den Men punkt Strukturierungswerkzeuge gt Anwendungsdefinitionen bearbeiten ge ffnet werden Mithilfe der Strukturansicht und des Elementekatalogs k nnen eigene Anwendungen definiert oder bestehende Anwendungsdefinitionen ge ndert werden Die folgende Abbildung zeigt die Anwendungsdefinition der Anwendung DITA Topic FM in der festgelegt wird welche Dateien beim Import oder
6. ssig sind und f r welche kommunikativen Zwecke sie verwendet wird vgl Sch flein Armbruster 2006 S 7ff Auf diese Weise festgelegte Funktionale Einheiten dienen den technischen Autoren als Rahmen bei der Erstellung von Texten Im praktischen Einsatz wird die Einhaltung der Regel durch die Verwendung von Redaktionsleitfaden und innerhalb der Autorenwerkzeuge typischerweise durch passende Formatvorlagen oder XML Elemente unterst tzt Auszeichnungselemente Auf der vierten und untersten Ebene der standardisierten Darstellung von Informationen stehen die Auszeichnungselemente Sie dienen zur Auszeichnung von Informationselementen innerhalb von Funktionalen Einheiten und legen ihre Verwendung fest Typische Beispiele f r Auszeichnungselemente sind Eingaben Feldnamen Symbole Men Produktnamen usw vgl Muthig und Sch flein Armbruster 2008 S 52 27 Neben der funktionalen Kennzeichnung k nnen definierten Kategorien von Informationselementen z B Handlungsanweisungen typografische Gestaltungsmit tel Nummerierung zugeordnet werden um die Zugeh rigkeit optisch zu kennzeichnen ber die Auszeichnungselemente werden dann Schriftart Schriftgrad Schriftschnitt Einzug Symbolverwendung usw geregelt Typografie und Layout folgen demnach prim r funktionalen verst ndnissicheren den nicht sthetischen Prinzipien Layout follows function Sch flein Armbruster 2006 Das hei t dass die optische Gestaltun
7. Der Einsatz von XML extensible Markup Language f r eine regelbasierte Erstellung und automatisierte Weiterverarbeitung der Dokumentation gewinnt damit zunehmend an Bedeutung XML ist zudem ein offenes Austauschformat das eine zukunftssichere und plattformneutrale Datenhaltung gew hrleistet In der Technischen Dokumentation wurden bereits branchenspezifische XML Standards entwickelt deren Verbreitungsgrad gegen ber propriet ren XML Anwendungen aufgrund ihrer Branchenspezifik und Komplexit t vergleichsweise sehr gering ist Als universelles Informationsmodell soll DITA Darwin Information Typing Architecture die Anforderungen der unterschiedlichen Branchen und Anwendungsgebiete erf llen Durch spezielle Dom nen und auch Attribute stellt DITA daf r vordefinierte Strukturen zur Verf gung die nach dem Konzept der Spezialisierung an eigene Anforderungen angepasst werden k nnen Die Erweiterun gen vorhandener und die Entwicklungen weiterer Dom nen werden durch die Unterarbeitskreise des OASIS Commitee f r DITA unterst tzt In dieser Diplomarbeit wird die Informationsstrukturierung Technischer Dokumen tationen in der Schienenfahrzeugtechnik nach dem DITA Konzept untersucht Der Schwerpunkt liegt auf der Erstellung von Handbiichern fiir die Druckausgabe Es wird dabei berpr ft ob die spezifischen Dokumentations und Strukturierungsan forderungen mit dem DITA Informationsmodell umgesetzt werden k nnen und inwieweit redaktionelle
8. Export verwendet werden und wo die entsprechenden Dateien gespeichert sind I VarbesB2a Rh rn AB TTT TTA Tla aele Sge structapps im 0 2 3 4 5 6 ul 8 Application Definition Version 8 Elemente z V SGMLApphcation J XMLApplication Defaults Application name opic F kempkate TD ml dita appiD ME Wopic template im DID mlidita apy Read write rules TD IRixml dita app DIT topic rulesixt DOCTYPE Conditional Text Output Text PLO utputaAll Te Entity locations Public ID Filename STRU a topic dtd Public ID iSISDTO D A Strukturansicht Filename TD a task d d Public ID Filename TD ditata 7 Public Dy X StructuredSetup Filename STR Public ID i Filename Public ID Filename app dtd Wopic did Public ID m aL DITA Map FM l DITA Book FM somLApplication J DocBook cmLAppication XHTML EronApptcton Dok structapps fm 100 ZUB gt CY NSNSHSeononr r27 gt 0 a aoo a Dll EEE Textfluss A E StructuredSetup 1 von 11 80 zZEB gt gt SMA 4BR Filename STR app dtd task dtd Public ID N Filename Public ID Filename Public ID Filename pp ide it XDocBook Use API client ditafm_app Abbildung 18 Anwendungsdefinition der DITA Topic FM in der structapps fm 60 Die Anwendungsdefinitionen der DITA Anwendungen sind im Wesentlichen gleich aufgebaut Uber Application name wird angegeben fiir welche Anwendung die jeweili
9. Informationsanalyse Ley 2006 S 4 Im folgenden Abschnitt werden zun chst die Ebenen der Textstruktur n her betrachtet In den weiteren Abschnitten werden die Strukturierungsmethoden Funktionsdesign und Information Mapping die als Modularisierungstechniken eingesetzt werden beschrieben 5 1 Texte und Textstrukturen Die Strukturierung von Texten erfordert eine einheitliche Systematik Textstrukturen k nnen nach verschiedenen Strukturierungsprinzipien in hierarchisch geordnete Ebenen unterteilt werden Klassisch wird die Textstruktur in zwei Ebenen unterteilt die Ebene der Mikrostruktur und die Ebene der Makrostruktur Die unterste Ebene die Mikrostruktur auch Feinstruktur ist die sprachliche Ebene mit der die eigentlichen Informationen abgebildet werden Gegenstand der Mikrostruktur ist der Satzbau bzw das Formulierungsmuster Die Makrostruktur auch Grobstruktur bildet die Grobgliederung des Textes ab vgl Badenbrink und Ried 2001 S 104 22 Ley 2006 f hrt zwei weitere Ebenen ein um die Strukturierungsprinzipien Funktionsprinzip und Inhaltsprinzip mit den Ebenen der Textstruktur in Zusam menhang zu bringen Zum einen die Mesostruktur oberhalb der Mikrostruktur und zum anderen die Metastruktur oberhalb der Makrostruktur vgl Ley 2006 S 2 Nach Ley 2006 spielt die Mesostruktur bei der Erstellung von Informationsproduk ten eine zentrale Rolle Diese Ebene ist an der Kommunikationsanalyse angelehnt wo
10. Prozesse unterst tzt werden Als Beispieldokumentation wird ein Benutzerhandbuch einer halbautomatischen Kupplung verwendet Nach der Einleitung wird im zweiten Kapitel wird die Redaktionsumgebung im Bereich der Schienenfahrzeugtechnik im Allgemeinen beschrieben und daraus die Anforderungen an die Qualit t und den Erstellungsprozess der Technischen Dokumentation formuliert Eine wesentliche Qualit tsanforderung ist die Konsistenz in der Technischen Dokumentation die unter anderem durch die Wiederverwen dung von Inhalt und Layout unterst tzt werden kann Inwieweit die Wiederverwendung konzeptionell umgesetzt werden kann soll im dritten Kapitel veranschaulicht werden Das vierte Kapitel behandelt XML Standards und deren Einsatz in der Technischen Dokumentation Dabei werden zun chst Vorteile genannt die den Einsatz von XML Standards begr nden In den weiteren Abschnitten werden die Konzepte der XML Standards SPEC 1000D mumasy und DocBook vorgestellt Das DITA Konzept liefert kaum Vorgaben nach welchen Regeln die Informationen zu strukturieren sind F r die Bearbeitung der Dokumentation wurden daher die Strukturierungsmethoden Funktionsdesign und Information Mapping herangezo gen Die Grundlagen f r die Informationsstrukturierung und modularisierung und die methodischen Ans tze werden im f nften Kapitel vorgestellt Im sechsten Kapitel wird das DITA Informationsmodell vorgestellt Dabei wird insbesondere auf relevante
11. Redakteuren Kontroll m glichkeiten zu gew hren Insbesondere dann wenn die Dokumentationen vorwiegend in gedruckter Form ausgegeben werden 6 4 2 Entscheidung f r Adobe FrameMaker 8 Die Entscheidung Adobe FrameMaker als XML Editor als Erstellungswerkzeug zu verwenden wurde in erster Linie unter den Gesichtspunkten Zielgruppe und damit Zielmedium getroffen Wie bereits beschrieben werden umfangreiche Technische Dokumentationen vorwiegend in geruckter Form zur Verf gung gestellt Die Ausgabe in Medien wie beispielsweise HTML spielt eine vergleichsweise unter geordnete Rolle Durch einen hohen Wiederwendungsgrad der Information soll vielmehr erreicht werden dass Inhalte produkt anwender und auch kundenspezifisch bereitgestellt werden k nnen FrameMaker ist ein Textverarbeitungssystem mit dem qualitativ hochwertige und umfangreiche Dokumentationen erstellen werden k nnen und eignet sich zudem auch als XML Editor Im Abschnitt 6 6 1 DITA Funktionen werden die FrameMa ker Funktionen zur Unterst tzung einer strukturierten Dokumentationserstellung mit DITA ausf hrlich beschrieben 53 6 5 Content Management Systeme CMS DITA ist ein sehr verwaltungsintensiver Standard vgl Hentrich 2008 S 313 Wie bei jeder modularen XML Anwendung liegen die Grenzen in der Menge der zu verarbeitenden Informationen bzw Module der zu erstellenden Dokumente Medien und Sprachvarianten Die Einfihrung ei
12. beim erneuten ffnen der DITA XML Datei das Tabellenformat nicht bersetzt Aus diesem Grund wurde nach dem lt image gt Element das Absatzelement lt p gt eingef gt in dem das lt table gt Element erlaubt ist MaA al E Strukturansicht io i HHimage SPERRE E lt GRAFIK gt m o SMB ABN 1 Hexagon head screw Fill hollow space witt 23 Dok SCH_r_connect xml Textfluss A 100 z ZAB Abbildung 33 Legende einer Abbildung ber das lt tgroup gt Element wird festgelegt wie viele Spalten eine Tabelle enth lt Innerhalb eines lt table gt Elements k nnen mehrere lt tgroup gt Elemente verwendet werden In dem lt tbody gt Element werden die Zeilen mit dem lt row gt Element und die Spalten in einer Zeile lt entry gt Elementen definiert Handlungsanweisungen Die Handlungsanweisungen werden im Task Topic erfasst F r die Inhalte wird nach dem lt title gt Element das lt taskbody gt Element eingef gt Das Task Topic kann beliebig viele Handlungsschritte lt step gt Elemente enthalten aber nur einen 80 Handlungsblock lt steps gt Element Die lt step gt Elemente stehen innerhalb des lt steps gt Element zur Verfiigung Die eigentlichen Anweisungen werden mit dem lt cmd gt Element command ausgezeichnet Unterhalb des ersten Handlungsschritts soll eine Abbildung eingefiigt werden auf die im Handlungsschritt verwiesen wir
13. beinhalten Zwar sind diese wiederverwendbar wird aber die Anzahl und der Umfang der Dokumentationen betrachtet erh ht sich der Verwaltungsaufwand erheblich Somit ist die Einf hrung einer XML Anwendung auch von DITA mit der Einf hrung eines CMS verbunden Eine Herausforderung bei der Bearbeitung der Dokumentation stellte die Modulbil dung nach dem topic orientierten Strukturierungskonzept dar Jeder Informationsbaustein bzw jedes Modul beginnt mit einer berschrift F r Dokumentationsinhalte die keine berschriften haben kann das lt t it le gt Element leer bleiben F r die Beispieldokumentation wurde festgelegt dass Text und Abbildung mit Legende und Bildbeschriftung in separaten Topics erfasst werden sollen Abh ngig von den Hersteller bzw Kundenvorgaben k nnen Text und Abbildung in beliebiger Kombination bzw Reihenfolge wiederverwendet werden wie beispielsweise Abbildung vor dem Text Abbildung nach dem Text Damit miissten keine Modulvarianten erstellt werden Bei der Zusammenfithrung der Topics entstanden allerdings nummerierte Uberschriften ohne Inhalt Muff coupling R Earthing S 3 3 1 Semipermanent SCHARFENBERG coupler half 2 035 167 B 6 Abbildung 41 Modulbildung und topic orientierte Strukturierung 89 Nach dem Generieren einer FrameMaker Buchdatei k nnen m ssen die Dokumente manuell Nachbearbeitet werden wie beispielsweise das Setzen von Seitenumbriichen an den entsprechende
14. capa400 lifting crane with a sufficient lifting capacit SCH_crane straps trestle lifting crane with a sufficient lifting cap SCH_straps lifting straps SCH_tourge torque wrench SCH_hammer hammer SCH_spirit level spirit level SCH_piece piece of wood as shock protection or plastic hamme SCH_stiff wire stiff wire for opening drain hole SCH_2 hexagon nuts 2 hexagon nuts ISO 4032 M16 8 A3P Alle Elemente anzeigen Abbildung 30 Einfiigen von conrefs Nach der Auswahl der Quelldatei werden im Auswahlfeld Element Tag die giiltigen Elemente angezeigt Im Auswahlfeld Elementdaten werden zu der ID auch die Inhalte der zu referenzierenden Elemente angezeigt Uber die Auswahl eines Elements und die Schaltfl che Insert k nnen Inhalte aus dem Quelldokument referenziert werden Die referenzierten Inhalte werden farblich blau gekennzeichnet und k nnen in den Zieldokumenten nicht ge ndert werden 77 SCH_install coupler_toolxml lt gt op ff Rp B b 7 js I To m p p ps ps Te 7 Te gps To Tools and materials standard tools lifting crane with a sufficient lifting capacity of 400 kg r SMR AHMAOT spirit level lifting straps Z Tools and materials MAs apal standard tools lifting crane with a suffic Dok SCH_install coupler_tool xml Textfluss A 100 z Z B Textfluss A E title dvoni 100 z ZOB gt Abbildung 31 Referenzierte Elemente aus
15. connection of earth strands e brass parts chromed parts e stainless screw fittings Version 1 04 04 Page 5 15 MAINTENANCE The following parts must be primed only back of bearing bracket film thickness min 15 um max 40 um e seats and screw unions of coupler components e cavity of coupling muffs non visible coupler components Coating K124 cr NOTE Time between painting must be approx 16 hours at 20 C a Non visible parts Epoxy resin primer non chromate unleaded Beige red RAL 3012 IDNR 165412 with epoxy hardener IDNR 117059 Mixing ratio 2 1 Film thickness 60 um b Visible parts 1 Priming Epoxy resin primer non chromate unleaded Beige red RAL 3012 IDNR 165412 with epoxy hardener IDNR 117059 Mixing ratio 2 1 Film thickness 60 um 2 Two pack epoxy finish Blue grey RAL 7021 with special hardener IDNR 991560 Mixing ratio 4 1 IDNR 991562 Film thickness 140 um Tolerance The overall film thickness should not exceed plus 30 microns or 30 unless special tolerances and film thicknesses are required Version 1 04 04 Page 5 16 TROUBLESHOOTING 6 Troubleshooting This chapter provides information which is useful for the detection and elimination of failures that may occur during operation Before starting the troubleshooting procedure a thorough visual inspection of the coupler should be performed in order to find out if the failure has been caused by
16. coupler half without being stretched or kinked 2 CAUTION Air pipe may leak Use soap solution to check connection and screw fitting of air pipe for leakage Use a soap solution to check the connection and screw fitting of the air pipe for leakage Check the vertical alignment of the coupler half Connect the earth strands at their fixing points e between the coupler shank and the bearing bracket and between the bearing bracket and the rubber cushion unit 7 2 4 Removing the coupler half Before removing the coupler half support it with a lifting crane The coupler half is to be remo ved in reverse order of installation For details refer to the individual sections of the components described in this chapter Version 1 04 04 Page 7 20 MOUNTING AND REPAIR INSTRUCTIONS 7 2 5 Shipping The coupler half will be delivered completely mounted on pallets or in boxes These have to be adequately secured in order to prevent shipping damage 7 2 6 Storage The coupler half should be stored indoors palletised and if possible protected from direct sunlight Prior to any storage it is imperative to remove all damage caused by corrosion and to renew the anticorrosive coating refer to the maintenance schedule and greasing plan For safety reasons the pluggable hose and the gasket of the air pipe connection should be re placed after longer storage periods exceeding 4 years before putting the coupler half into ope ratio
17. der Hierarchie vgl Fritz et al 2008 S 43 Neue Module k nnen hinzugef gt werden ohne nderungen an den bereits vorhandenen vorzunehmen 61 Die Modularisierung orientiert sich an den vorhandenen Topic Typen und Dom nen Dementsprechend geh ren zu jedem Topic Typ zwei Dateien Typ Modul mod enth lt definierte Elemente und Attribute Shell DTD dtd enth lt f r einen Typ erforderlichen Dom nenspeziali sierung Zu jeder Dom nenspezialisierung geh ren ebenfalls zwei Dateien Modul mod enth lt die Deklaration der Elemente und Attribute f r die Dom ne Entity Datei ent enth lt Parameter Entities um das Modul in die Shell DTD eines Typen zu integrieren B did O 2 e m assessment dtd GB assessment mod concept dtd concept mod highlightDomain ent highlightDomain mod dmap dtd map mod GaimapGroup ent mapGroup mod metaDecl mod reference dtd reference mod Gh softwareDomain ent EA softwareDomain mod fGahtask dtd task mod GA tbiDecl mod topic dtd topic mod GA topicAttr mod itopicDefn ent GahuiDomain ent B uiDomain mod Eh programmingDomain ent Bdutilitiesdomain ent ED PprogrammingDomain mod ButiltiesDomain mod Dateiname dita book fm dtd v Dateityp Alle Dateien Abbildung 19 DITA DTDs Die in der Anwendung DITA Book FM definierte Struktur umfasst alle in DITA Topic FM enthaltenen El
18. ends grease AUTOL TOP 2000 stiff wire for opening drain hole 4 1 2 Preparation 2 CAUTION Risk of damage to coupler halves Make sure that semipermanent coupler halves are compatible before connection Make sure that the centring bush of the coupler half is properly aligned with the centring cone of the mating coupler half Visually check the coupler halves for damage Clean the shank collars to connect the muff coupling the inner surfaces of the muffs and the air pipe connections Apply RIVOLTA GWF to screw ends Grease the collars of coupler shanks with AUTOL TOP 2000 Place lower muff on the air pipe connection before driving the cars together The lower muff cannot be installed after the cars have been moved together Version 1 04 04 Page 4 10 OPERATING INSTRUCTIONS 4 1 3 Connecting the coupler halves 1 Slowly drive the cars together ensuring that the coupler halves are close together CAUTION Muff couplings may corrode Do not confuse muffs Muff with drain hole must be placed face downward CAUTION Risk of failure of coupler Make sure that seat engaging surfaces of nuts are free from paint and grease in order to ensure correct tightening torque 2 Place upper muff on the collars of the coupler shanks and introduce new hexagon head screws into the bores 3 Screw on hexagon nuts and new lock washers by hand Slightly tap muffs with a hammer place piece of wood underneath to ensure
19. inhaltlichen Unterschieden wie sie zwischen unterschiedlichen Produktvarianten entstehen nicht wiederzuverwenden Beispielsweise f hrt eine nderung in der Handlungsanweisung aus dem vorherigen Abschnitt Connection of coupler halves zu einem komplett neuen Modul auch wenn die restliche Beschreibung gleich bleibt Es entstehen hnliche Module die redundante Informationen enthalten Weitere nderungen m ssen dann parallel durchgef hrt werden bersetzungsprozesse mehrfach durchgef hrt werden Unter diesen Gesichtspunkten wurden die Informationselemente Tools and materials Preparation Connection the coupler halves und Final activity in einzelne Module aufgeteilt und entsprechend ihrer Informationsart einem Topic Typen zugeordnet Eine Aufteilung in kleinere Module w rde h here Verwaltungsaufw nde verursachen und zudem auch unzweckm ig sein w rden beispielsweise die Informationselemente einer Abbildung in Module auf Satzebene aufgeteilt werden Da bei den Arbeitsausf hrungen fast dieselben Werkzeuge Tools and materials ben tigt werden entstanden durch diese Aufteilung Modulvarianten mit redundan ten Informationen die entweder identisch waren oder sich um ein anderes oder zus tzliches Werkzeug oder Material unterschieden Aus diesem Grund wurden die Werkzeuge in einem Topic SCH_tools and materials xml zusammengefasst Somit sollen die verwandten Module identische Informationen nicht redundant halten
20. is con cerned The greasing points are shown in section Anticorrosion measures and greasing plans 5 2 1 Explanation of the maintenance schedule e The table is structured according to the coupler components e The steps described in the following are intended as short descriptions only They do not replace the detailed descriptions given in chapter Mounting and repair instructions Version 1 04 04 Page 5 13 MAINTENANCE e Ifa step requires any tools and materials beyond the standard tools such special tools and materials are mentioned expressly 5 3 Anticorrosion measures and greasing plans gt CAUTION Risk of corrosion of coupler Anti corrosive coat can be damaged during coupling Repair anti corrosive coat during maintenance Make sure that coating does not exceed maximum allowed value in order to ensure perfect coupling gt CAUTION Risk of lubricating film break Do not mix different greases Different types of saponification are incompatible with each other and might lead to insufficient greasing 2 CAUTION Rubber parts may get damaged Rubber parts must not get in contact with grease In order to prevent corrosion of the coupler you must repair the anti corrosive paint and coa tings during the maintenance activities 5 3 1 List of materials and greasing points for preventive maintenance This manual describes mounting and repair of the coupler presupposing that the materials li ste
21. logische Ausdr cke zu definieren und stellt dazu Funktionen bereit wie String Funktionen numerische Funktionen Knotenmengenfunktionen vgl Becher 2008 S 84 11 4 XML Standards fur Dokumentationsstrukturen In der Technischen Dokumentation wird zwischen branchenspezifischen und universellen XML Standards unterschieden Branchenspezifische Standards sind beispielsweise mumasy f r den Maschinen und Anlagenbau SPEC 1000D f r die milit rische Luft Fahrzeugindustrie ATA iSpec 2200 f r die zivile Luftfahrtindustrie Text Encoding Initiative f r Geisteswissenschaften Offene universelle Standards wie DocBook und DITA sind dagegen branchenunab hangig Im folgenden Abschnitt sollen zunachst Vorteile genannt werden die den Einsatz eines XML Standards f r die Dokumentationserstellung begr nden In den weiteren Abschnitten werden die Standards mumasy SPEC 1000D und DocBook im Einzelnen kurz beschrieben DITA ist Schwerpunkt dieser Diplomarbeit und wird in Kapitel 6 Darwin Information Typing Architecture DITA ausf hrlicher behandelt 4 1 Vorteile und Nutzen von XML Standards Erste Zahlen einer aktuellen CMS Studie 2008 belegen dass firmenspezifisch entwickelte Strukturdefinitionen und Standards mit 38 5 Prozent noch immer den h chsten Verbreitungsgrad in der Technischen Dokumentation aufweisen Weniger verbreitet sind die Strukturierungsstandards vgl Fritz 2008 S 1 2 DocB
22. loose connections or damaged components Troubleshooting has to be made in logical steps in order to ensure pro per fault isolation The troubleshooting list does not include all possible faults and potential causes but only the most probable ones Please note that there may be several faults appearing at the same time Troubleshooting should be performed by skilled personnel only in order to ensure perfect reco gnition of faults and evaluation of symptoms 6 1 Explanation of the following tables e The tables are arranged according to the order in which the components of the coupler half are described in chapter Components Description and function The maintenance steps described in the following are intended as short descriptions only They do not substitute the full descriptions given in chapter Mounting and repair instructions 6 2 D Failure of air pipe connection Kind of failure Probable cause Remedy Leakage of pipe connection Gasket is damaged Replace gasket air pipe connection must not be removed see 5 2 D Hose screw joint or sealing ring is damaged Version 1 04 04 Page 6 17 MOUNTING AND REPAIR INSTRUCTIONS 7 Mounting and repair instructions This chapter deals with the removal disassembly installation inspection and adjustment of su bassemblies This manual describes mounting and repair of the coupler presupposing that the materials li sted in chapter Par
23. sections in this chapter e Air pipe connection D e Coupler shank with collapsible tube F e Rubber cushion drawgear G e Muff coupling R e Earthing S 3 3 1 Figure 3 1 Semipermanent SCHARFENBERG coupler half 2 035 167 B EFG3 SSmm Druckhub stroke on compression kina Zughub stroke on tension Ver formungsrohr Oruckhud 150mm 1100kN Deformation tube stroke on compress ion 150mm 1100kN 1 Name plate 7 Rubber cushion drawgear 4 Air pipe connection 36 Muff coupling 6 Coupler shank 43 Earthing 3 3 2 Air pipe connection D The air pipe connection is mounted below the coupler shank During coupling the gasket of the Version 1 04 04 Page 3 4 COMPONENTS DESCRIPTION AND FUNCTION air pipe connection is pressed against the gasket of the mating coupler half thereby providing a tight seal for the air connection The centring sleeve ensures proper alignment with the air pipe connection of the mating coup ler half Figure 3 2 Air pipe connection D 1 Gasket 7 Nut 2 Air pipe conection 8 Springe type straight pin 3 Centring sleeve 3 3 3 Coupler shank with collapsible tube F The coupler shank contains a collapsible tube that is designed to absorb heavy buff loads ex ceeding the absorption capacity of the rubber cushion drawgear Connection The front and rear ends of the coupler shank are provided with collars to allow connection to the mating coupler and to the rubber cushion drawgear
24. z ZAD gt Abbildung 34 Handlungsanweisung mit Sicherheitshinweisen und einer Abbildung Mit weiteren lt step gt Elementen k nnen die Handlungsschritte fortgesetzt werden Die Auszeichnung und das Referenzieren der Sicherheitshinweise werden im Folgenden behandelt 81 Sicherheitshinweise Die Sicherheitshinweise wurden wie die Werkzeuge Tools and materials auch in einem generischen Topic Quelldokument zusammengefasst und sollen ebenfalls ber den conref Mechanismus an den entsprechenden Stellen referenziert werden Die DITA Struktur hilt fiir die Formulierung eines Sicherheitshinweises das Element lt note gt mit einer Reihe vordefinierter Attributwerte fiir das optionale Attribut type bereit So stehen unter anderen die Werte caution danger other zur Verf gung Wird der Wert other angegeben kann ber das othertype Attribut ein anderer Wert z B warning zugewiesen werden Weitere Strukturelemente die eine Auszeichnung in Anlehnung an die ANSI ISO erm glichen sind nicht gegeben SCH_safety_precautions xml lt gt 0 1 2 3 5 6 7 8 3 10 11 12 13 14 15 16 17 18 9 20 oO a dacia Safety precautions 7 WARNING Danger to health Hazardous vapours may be produced when using 4 cleaning solvents Observe applicable safety regulations P 9 4 Strukturansicht Xs m co a a q Safety precautions 4 r raaa aroda Danger to health Hazardous vapo F type oth
25. Benutzerhandbuch 2007 Version 2007 http help adobe com de_DE FrameMaker 8 0 framemaker_8_help pdf Abruf 10 07 2007 s n 2007 Badenbrink Stefan und Ried Tilo 2001 Vom Informationsmanagement zum Wissensmanagement mit SGML XML Buchverf Jorg Hennig Informations und Wissensmanagement f r technische Dokumentation L beck Verlag Schmidt R mhild 2001 Bd 4 Becher Margit 2008 Einf hrung in XSLT Buchverf Elisabeth Gr fe Standardisierung versus Kreativit t Stuttgart tekom 2008 S 84 87 Bergert Sven 2007 OASIS gibt DITA Version 1 1 frei Hrsg TANNER AG 2007 04 S 1 2 B hler Klaus 2008 Die Strukturierungsmethode Information Mapping IMAP Buchverf J rgen Muthig Standardisierungsmethoden in der Technischen Dokumentation L beck Verlag Schmidt R mhild 2008 Bd 16 2001 Modulare Informationseinheiten nach Information Mapping als Basis fiir effizientes Informationsmanagement Buchverf Jorg Hennig Informations und Wissensmanagement f r technische Dokumentation L beck Verlag Schmidt R mhild 2001 Bd 4 Brinker Klaus 2001 Linguistische Textanalyse Eine Einf hrung in Grundbegriffe und Methoden 5 Auflage Berlin Erich Schmidt Verlag 2001 Closs Sissi 2005 DITA ein neuer Standard mit Zukunft Online 2005 http www doku info doku_article_191 html Abruf 2008 07 16 2008 Single Source in der Technischen Dokumentation Online 2008 URL http ww
26. DITA Map teferenzieren un nn 46 Abbildung 12 GrimdstrukturreinerB5okm p ann a ea a a 46 Abbildung 13 Metadaten in einem Topic sas teviesetassasteedvalivessatoendiedanvinltadomenavsanidnsndiss dhegrtorst 49 Abbildung 14 Einstellung von DITA Optionen uunnsnesenssensenensensensenensensonensensnnensansnnensansane 56 Abbildung 15 Ansicht im Strukturierten FrameMaker ununsnesnnenenenennenenennannene 57 Abbildung 16 Elementekatalog Strukturansicht und Dokument auf einer Oberfl che 57 Abbildung 17 Verf gbare Elemente f r eine Map zuweisen unnssmesenenenenennensnennaneene 58 Abbildung 18 Anwendungsdefinition der DITA Topic FM in der structapps fm 60 Abbildung 19 DITA DTD8 uu u ar aaa 62 Abbildung 20 Ansicht der EDD f r die DITA Topic FM Anwendung eeeeene 63 Abbildung 21 Strukturiertes Template nn anne 64 Abbildung 22 Makrostruktur des Benutzerhandbuchs essesenenenneneneenen 66 Abbildung 23 Sicherheitshinweise vor einem Handlungsschtritt eeseeseenene 67 Abbildung 24 Auszug aus einer Handlungssequenz nsnenessnsensenensensensenennensenennensnnnn 68 Abbildung 25 Abbildung und die Elemente der Abbildung uenesnsneen 69 Abbildung 26 Verwenden von Informationen aus einem gemeinsamen Reuse Pool 71 Abbildung 27 Ansicht der Topic Dateien im Dateisystem Auszug neeneene 72 Abbildung 28 Projektvetzeichnis u nne a aaa a 73 Abbi
27. Die Beispieldokumentation f r diese Arbeit wurde nach der Buchgenerierung nicht nachbearbeitet Die Auswertung der Dokumentation erfolgt im Abschnitt 7 4 lt c Auswertung 7 3 3 Weiterverarbeitung der DITA XML Dateien Da FrameMaker DITA konforme XML Dateien erstellt k nnen diese in jedem XML Editor der DITA XML Dateien verarbeiten kann weiter verarbeitet und in andere Zielmedien ausgegeben werden Eine weitere M glichkeit die DITA XML Dateien beispielsweise ein HTML Format auszugeben ist die Integration des DITA Open Toolkits ber das Adobe FrameMaker 8 Plug in 85 Dazu m ssen zun chst das DITA Open Toolkit und anschlie end das FrameMaker Plug in installiert werden Bei erfolgreicher Installation steht im DITA Men Verzeichnis die Funktion Generate Output zur Verf gung Build Type Current File Selected Target chm html pdt Options View Log File Open Output Folder Keep This Dialog Open After Build DITA OT Directory E DITA 0T1 5 B DITA Generate Output mim Abbildung 39 Dialogfenster f r das DITA Open Toolkit ber das Dialogfenster f r das DITA Open Toolkit kann das gew nschte Ausgabe format CHM HTML oder PDF ausgew hlt werden wobei f r die PDF Ausgabe die FrameMaker Funktionen verwendet werden k nnen Mit der Option Current File wird f r die Transformation ein vorkonfiguriertes ANT Script ditafm ant xml verwendet das bei der Installation des Adobe Pl
28. Dokumentation in der Schienenfahrzeugtechnik basiert noch oft auf propriet ren Applikationen und Datenformaten F r die Dokumentationserstellung ist die Verwendung von DTP Werkzeugen wie Microsoft Word und Adobe FrameMaker noch immer weit verbreitet Ein Grund daf r kann sein dass die Dokumentationen dem Anwender vorwiegend in gedruckter Form zur Verf gung gestellt werden Beispielsweise werden die Bedienhandlungen vom Fahrpersonal nicht am Bildschirm gelesen Das bedeutet dass die Bereitstellung der Inhalte in anderen Ausgabemedien Online Hilfe Webseiten wenig oder sogar nicht gefordert wird F r die Druckausgabe oder zur Speicherung auf einem externen Datentr ger CD ROM sind also Textverarbeitungssysteme durchaus ausreichend Allerdings sind propriet re Datenformate system und toolabh ngig was aufgrund der langlebigen Dokumentationen abh ngig vom Produktlebenszyklus einen gro en Nachteil Lizenzkosten zus tzliche Konverter usw darstellt Ein weiterer Nachteil ist dass Inhalt und Layout nicht getrennt voneinander bearbeitet werden k nnen was unter anderem zu aufwendigen Formatierungsarbeiten f hrt wenn beispielsweise die Dokumentation f r verschiedene Kunden aufbereitet oder in anderen Sprachen bersetzt werden soll Entsprechend ihrer Funktion sind die Dokumentationen inhaltlich und strukturell unterschiedlich aufgebaut haben aber auch identische Inhalte wie allgemeine Sicherheitshinweise Copyright Informati
29. ES_g_conil Design and suba Anchoring to car underframe SCH_DES_g_ancl SCH_figure_g xml fm topicreflabel R Muff counting P ISCH DES r vent Textfluss A E topicref 1 von 3 Abbildung 37 Erstellen einer DITA Map lt gt 0 SMAA Das Buch wird letztendlich ber den Befehl DITA gt FM DITABook aus einer DITA Map Datei erstellen generiert 84 MM E Projects co BE Hex SO E Projects contents_DITA Buch _ SCH_GI xml tm E SCH_SP xml fm SE SCH_DES xml tm E SCH_OI xml fm SCH_MT xml frn SE SCH_TS xmlfm E SCH_MRI xml fm E SCH_PL xmlfm pemn ranar Abbildung 38 Ansicht der Buchstruktur Von dem generierten FrameMaker Buch wird in der Regel eine Kopie erstellt die weiterverarbeitet werden dann kann Weitere Arbeitsschritte k nnen beispielsweise die Generierung eines Inhaltsverzeichnisses und die Erstellung eines PDF Dokuments ber die entsprechenden Buchfunktionen von FrameMaker sein Letzeres erfolgt ber die Auftragsoption zur PDF Erstellung im FrameMaker Das bedeutet dass alle f r ein Buch typischen Elemente wie Titelei Inhaltsverzeichnis Index Seriennummern usw dem FrameMaker Buch hinzugef gt werden Die Inhalte der DITA Map Datei sollten allerdings deckungsgleich mit den Inhalten der FrameMaker Buchdatei sein was wiederrum bedeutet dass Layout Inhalte und Struktur in der Buchdatei nicht ver ndert werden d rfen
30. Eigenschaften f r die Erstellung von Handb chern eingegangen Das Benutzerhandbuch der halbautomatischen Kupplung wurde anhand der beschriebenen Grundlagen f r die Informationsstrukturierung und der vordefinierten DITA Struktur erstellt Die Vorgehensweise und die Ergebnisse werden im siebten Kapitel beschrieben 2 Anforderungen an die Technische Dokumentation in der Schienenfahrzeugtechnik Neben den rechtlichen Anforderungen sollen Technische Dokumentationen aus marktwirtschaftlicher Sicht m glichst konomisch revisions und bersetzungs freundlich erstellt werden Aus der Perspektive der Endanwender m ssen die erstellten Dokumentationen verst ndlich sein Um allen Anforderungen gerecht zu werden wird h ufig versucht die L sungsans t ze zur Optimierung von Redaktionsprozessen zuerst auf der technischen Seite zu suchen Redaktionelle Fragen stehen dabei am Rand Unerw nschte Folgen k nnen eine ungeeignete Werkzeug und System Auswahl und damit zus tzliche Kosten sein Aus diesem Grund sollte eine Analyse der tats chlichen Anforderungen an die Technische Dokumentation der Werkzeug Auswahl vorangestellt werden Das Thema dieser Diplomarbeit bezieht sich auf die Technische Dokumentation in der Schienenfahrzeugtechnik Im folgenden Abschnitt soll zun chst die Ausgangslage beschrieben werden Dabei wird speziell auf die Besonderheiten bzw Gegebenheiten die bei der Erstellung von Technischen Dokumentationen bestehen eingega
31. Funktion in unterschiedliche Textsorten ein und liefert die theoretische Begr ndung f r die Klassifizierung nach Sprechakten vgl Muthig und Sch flein Armbruster 2008 S 42 Nach der sprechakttheoretischen Betrachtungsweise wird eine sprachliche u erung als sprachliche Handlung Illokution angesehen die ein Sprecher in einer kommunikativen Absicht Perlokution vollzieht Dabei bermittelt er Inhalte Proposition An diese Betrachtungsweise kn pft die FD Methode an und fragt welche sprachlichen Handlungen der Autor Sprecher vollzieht wenn er beispielsweise eine Bedienungsanleitung verfasst um ein definiertes kommunikatives Ziel zu erreichen Im Unterschied zur m ndlich dialogischen Kommunikation handelt es sich dabei um eine schriftlich monologische Kommunikationsform die zeitversetzt stattfindet vgl Muthig und Sch flein Armbruster 2008 S 43 Diese Besonderheit stellt spezifische Anforderungen an die Erstellung eines schriftlichen Textes Bei der Kommunikation m ndlich und schriftlich geht es im Wesentlichen darum dass zum einem die Inhalte einer u erung vom Empf nger verstanden werden und zum anderen die kommunikative Funktion z B Warnung Aufforderung Erkl rung die die u erung in einem bestimmten Kontext hat Dazu werden in der m ndlichen Kommunikation zus tzlich metasprachliche Mittel z B Intonation Tonfall eingesetzt um das richtige Verst ndnis einer u erung zu gew hrleisten In der schriftl
32. Mesostrukturen f r Frage Antwort Sequenzen stehen Das Funktionsprinzip kommt auf dieser Ebene am st rksten zum Tragen Ley 2006 S 2 Ihre Elemente werden als Funktionale Einheiten oder als kommunikative Einheiten bezeichnet Die oberste Ebene eines Informationsprodukts ist die Metastruktur Auf dieser Ebene werden Elemente der Makrostruktur in eine bestimmte Reihenfolge gebracht und publiziert vgl Ley 2006 S 2 In der klassischen Unterscheidung zwischen Mikro und Makrostruktur geh ren die Ebenen Meso und Metastruktur noch zur Makrostruktur da diese bergeordnete Sinneszusammenh nge darstellen vgl Badenbrink und Ried 2001 S 104 5 2 Funktionsdesign Funktionsdesign FD ist eine Standardisierungs Strukturierungs und Schreib technik f r technische Informationen und Dokumentationen die von Robert Sch flein Armbruster und J rgen Muthig Anfang der 1990er Jahre entwickelt wurde Es ist eine Methode um Informationsprodukte bedarfsgerecht zu modellieren Nach Sch flein Armbruster 2006 S 7 bedeutet modellieren Strukturierung der Inhalte auf Makro und Mikroebene den Einsatz von Text und Bild standardisieren Regeln bereitstellen um wirtschaftlich und qualit tsgesichert zu produzieren 23 Diese Methode basiert auf der Sprechakttheorie die Anfang der 1960er Jahre von Searle und Austin in der Sprachwissenschaft entwickelt wurde Die Sprechakttheorie teilt Inhalte nach ihrer kommunikativen
33. S notwendig Die Einarbeitung in die DITA Struktur und die konzeptionelle Vorarbeit f r die Dokumentationserstellung erwies sich als zeitaufw ndig insbesondere bei der Typisierung und Modularisierung der Inhalte L sungsans tze bieten die Strukturie rungsmethoden Funktionsdesign und Information Mapping Im Hinblick auf den anspruchsvollen Dokumentationsbedarf der Schienenfahrzeuge was sich im Umfang der Dokumentationen abzeichnet entsteht durch die Modulbildung zus tzlich ein hoher Verwaltungsaufwand Da DITA keinen eigenen Mechanismus zur Versions verwaltung und zur Steuerung des Redaktionsprozesses bietet m ssen diese Komponente extern umgesetzt werden beispielsweise in einem CMS F r die Verwendung von DITA als universelles unternehmens bergreifend Austauschformat m ssen die bestehenden M glichkeiten von DITA deutlich 91 erweitert werden In der Schienenfahrzeugtechnik stellt im Allgemeinen die Einf hrung von XML als Datenaustauschformat eine gr ere Herausforderung dar Selbst der speziell f r den Maschinen und Anlagenbau entworfene Standard mumasy erreicht in Anwenderkreisen nur eine geringe Akzeptanz 92 Literaturverzeichnis Adobe FrameMaker 8 Plug in Installationsanleitung 2007 Using the Adobe FrameMaker 8 Plug In for DITA Open Tool Kit Adobe Developer Connection Online 31 08 2007 URL http www adobe com devnet framemaker fm8_opentoolkit html Abruf 2008 09 01 Adobe FrameMaker 8
34. SCH_DES_techdata xmi 2 SCH_figure_coupler half xmi 2 SCH_figure_d xmi 2 SCH_figure_f_character xml L2 SCH_figure_fitt dim coupler xml Abbildung 27 Ansicht der Topic Dateien im Dateisystem Auszug CH_figure_g xmi CH_figure_g_character xml CH_figure_locat greasing xml CH_figure_r_1 xml 2 SCH_figure_r_2 xml E SCH_figure_s xml 2 SCH_fiqure_vert align xml 2 SCH_GI xml 2 5CH_MRI xml E SCH_MRI_equipment xml 2 SCH_MRI_install coup xml IE SCH_MRI_install coup_preparation xml 2 SCH_MRI_install coup_remove xmi 2 5cH_MRI _install coup_shipping xml 2 SCH_MRI_install coup_steps xml 2 SCH_MRI_install coup_storage xml 2 SCH_MRI_install coup_tool xmi 2 SCH_MRI_mount adjust xml 2 SCH_MRI_vert align xmi 2 SCH_MRI_vert align_preparation xmi 2 SCH_MRI_vert align_steps xmil E SCH_MRI_vert align_tool xml 2 SCH_MT xml 2 SCH_MT_anticorr greasing xml E Wechsein 2 2 5CH_MT_coating backup xml E SCH_MT_coating xml 2 SCH_MT_coating_coatingk124 xml 2 SCH_MT_coating_parts not paint xml 2 SCH_MT_coating_parts primed xml 2 SCH_MT_coating_preparation xml SCH_MT_coating_tool xml 2 SCH_MT_general xml 2 SCH_MT_general_loosing connect xml SCH_MT_general_preparation xml 2 SCH_MT_general_replacement xml 2 SCH_MT_list of materials xml e SCH_MT_maint sched xml a 33 E 2 e SCH_MT_maint sched_explan table xml 2 SCH_OL xml SCH_OI_connect xml 2 SCH_OI_con
35. UNTERSUCHUNGEN ZUR STRUKTURIERTEN DOKU MENTATION MIT DITA IM BEREICH DER SCHIENEN FAHRZEUGTECHNIK DIPLOMARBEIT IM FACHBEREICH INFORMATIK UND KOMMUNIKATIONSSYSTEME DER HOCHSCHULE MERSEBURG FH vorgelegt von Maren Stypka KTD 04 aus Schkopau Erster Betreuer Herr Dr Thomas Meinike Zweiter Betreuer Herr Dr G nter Ratz eingereicht am 19 01 2009 Inhaltsverzeichnis Inhaltsyerzeichn s ee eines oe eae ae I Abk rz ungsverzeicnis u analnehmkehhihene II Abbildungsverzeichnis u uses IV Tabellenverzeichnis un er Dee VI T Einleitung 4 Bun E aoaeiaa So Ka a aaas iVE na Eissii 1 2 Anforderungen an die Technische Dokumentation in der Sehienenfahrzeustechnik nenne ame ner 3 2 4 Ausgangslage Stand der Diner 3 2 2 Anforderungen an die Qualit t der Dokumentationen uunessensenensensensenen 5 2 3 Unterst tzung der Dokumentationsprozesse uunnseenesensenensensnnennensensnnensnnennensanen 7 3 Wiederverwendung von Informationen zurssorssnssonssnsssnssonsnonsonssnnssnnnsnnsonsnnnsone 9 3 1 Simple Source Publishing niione nme sea 9 3 2 XML als Schl sseltechnologie 2 2 ER 10 4 XML Standards f r Dokumentationsstrukturen uusssssssssssnssossnssnssnnsnssnnssennunne 12 4 1 Vorteile und Nutzen von XML Standards uussseesenennensensenensensenensensenennanenn 12 4 2 SPEC 1000D siria oannes asra e I EE NETTS 14 4 3 AMUMASY iioi i i ai a e a i a i ADE ae 17 oA WC Book an EO TE EET EETA 19 5 Struktu
36. aker importiert Die FrameMaker Datei wird mit Mif2Go von Omni Systems nach DITA berf hrt Die Inhalte der Word Dokumente werden mittels Copy amp Paste Methode bernommen Hinsichtlich der DITA Struktur werden bei den ersten beiden genannten Methoden nur wenige Strukturinformationen transportiert womit nachtr glich weitere Anpassungen notwendig sind vgl Hentrich 2008 S 140 74 Aus diesem Grund wurde bei der Erfassung der Inhalte die Copy amp Paste Methode angewendet Dadurch bestand die M glichkeit die bestehenden Inhalte nach ihrer Informationsart gezielt in den entsprechenden Topics zu erfassen und vorhandene Strukturm ngel zu beheben 7 3 1 Erstellen der Topics Die Vorgehensweise zur Erstellung von Topics soll anhand eines Beispielkapitels Anhang A dargestellt werden Dabei wird besonders auf die Verwendung des conref Mechanismus und auf die Erstellung von Abbildungen und Handlungsanwei sungen eingegangen Um die bisher beschriebenen Konzepte n her zu veranschaulichen wurde zur Darstellung ein Kapitel gew hlt das typische Strukturmerkmale des Benutzerhandbuchs enth lt Listen f r Aufz hlungen Abbildungen Tabellen Abbildungsbeschriftung Sicherheitshinweise Nummerierte Listen f r die Handlungsanweisungen Verwendung des conref Mechanismus Wie bereits im Abschnitt 7 1 2 Modularisierung der Informationen beschrieben sollen die Inhalte der Module Tool and materials in einem Topic Quel
37. angegebenen Hilfsmittel benutzt und alle w rtlichen oder sinngem en Entlehnun gen deutlich als solche gekennzeichnet habe Datum Ort Unterschrift 96 Anhang A Beispielkapitel Installation of the coupler half SCHARFENBERG COUPLER NO 2 035 167 MOUNTING AND REPAIR 5 1 Mounting and adjustment 5 1 1 Installation of the coupler half Tools and materials e Standard tools e lifting crane with a lifting capacity of 400 kg e spirit level e lifting straps Preparation The anchoring plate for the coupler half on the car underframe must be plane and rectangularly aligned to the underframe both vertically and horizontally Check the level surface and rectangular position of the plate according to ISO 2768 K Adjust if necessary 2 CAUTION Centre of hole configuration on anchoring plate is identical with centreline of coupler half Use a level to check and adjust horizontal alignment of longitudinal and transversal axes Make sure that there is sufficient space behind the anchoring plate for the tools to be used Installing the coupler half 1 Make sure that the holes in the anchoring plate correspond to the hole configuration shown in Fig 5 1 1 1 525 440 0 3 285 200 0 3 Anschlu ma e am Fahrzeug Interface dimension on vehicle Fig 5 1 1 1 Fitting dimensions for the coupler half in mm Version 1 04 04 Page 5 2 SCHARFENBERG COUPLER NO 2 035 167 MOUNTING AND REPAIR 2 Support the coupler hal
38. as lt title gt Element nur vor dem lt image gt Element stehen darf Eine M glichkeit die Abbildungsbeschriftung doch unter die Abbildung und Legende zu platzieren ist die Verwendung des lt figgroup gt Elements das nur f r DITA Spezialisierungen vorgesehen ist Closs 2007 S 197 Da keine weiteren Erl uterungen zur Verwendung des lt figgroup gt Elements recherchiert werden konnten wurde bewusst auf dessen Verwendung verzichtet SCH_install coupler_figure smi lt gt 0 1 2 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 9 20 MASAA Sei E LI Teac d image lines k m a ir ee OMAA ADA SISSSSSSSCSCCSA gee g 8 Figure l l Fitting dimensions f lt GRAFIK gt iil Dok SCH_install coupler_figure xml Textf 100 z Z ff von i 80 z ZOa lt 22 HE Textfluss A E fig Abbildung 32 Abbildung mit einer Abbildungsbeschriftung Die Legenden der Abbildung sollen in Tabellen erfasst werden Unterhalb des lt image gt Elements ist das lt simpletable gt Element erlaubt 79 Innerhalb des lt simpletable gt Elements k nnen die Elemente lt sthead gt Kopf lt strow gt Zeile lt stentry gt Spalte die vom lt fm stbody gt umfasst werden Damit analysiert FrameMaker die Anzahl der Tabellenspalten um die Tabelle ordnungsgem anzuzeigen FrameMaker 8 Benutzerhandbuch 2007 S 565 Allerdings wird beim Import quasi
39. ateien beispielsweise zu PDF Dateien kein Standardsatz von Stylesheets bereitgestellt wird vgl Hentrich 2008 S 88f Als ein Vorteil von mumasy wird die unternehmensweite Verkn pfung von Informationen ber den gesamten Produktionszyklus hinweg angesehen Der Mehrwert der dadurch entsteht rechtfertige die Komplexit t Interessant sei mumasy bez glich der Integration von Zuliefererdokumentationen vgl Schmidt 2006 S 24f Durch den geringen Einsatz kommen die Vorteile allerdings nicht zum Tragen Ein Sog muss entstehen Das k nnte zum Beispiel dadurch geschehen dass ein gro es Unter nehmen auf mumasy umstellt und das gleiche von seinen Zulieferern erwartet Schneeberger in Schmidt 2006 S 25 18 4 4 DocBook DocBook ist ein Dokumentenformat das in einer fir SGML und XML vorliegenden Document Type Definition DTD festgelegt ist Es wurde speziell fiir die Erstellung von B chern Artikeln und Dokumentationen im technischen Umfeld entwickelt Der Schwerpunkt der semantischen Auszeichnung liegt auf der Software und Hardware Dokumentation vgl Hentrich 2008 S 77 Im Gegensatz zu den branchenspezifischen Standards f r die Technische Dokumen tation z B mumasy f r den Maschinen und Anlagenbau ist DocBook ein branchen bergreifender Standard DocBook wurde erstmalig 1992 von der Davenport Gruppe ver ffentlicht einem Konsortium von Herstellern technischer Dokumentationen und unter der F hrung des amerikani
40. aus dem FrameMaker Programmverzeichnis kopiert umbenannt und an das Projekt angepasst 73 In der Datei structapps fm wurden dafiir neue Anwendungen Chapter Map und FM Buch definiert die fiir das Projekt verwendet werden In den EDDs wurden beispielsweise die Pr fix und Suffix Regeln ge ndert Mit diesen Regeln erh lt der textliche Inhalt eines Elements einen Zusatz z B f r das lt step gt Element das Wort Task Diese Zusatzinformationen wurden entfernt Die Anpassungen des Text und Seitenlayouts wurden in den Templates vorgenommen Im Unterverzeichnis contents_DITA befinden sich die Topics und die Map Wird aus einer Map ein FrameMaker Buch generiert werden die Buchdateien im Unterver zeichnis contents_FM abgelegt Im graphics Verzeichnis befinden sich die verwendeten Abbildungen und im out Verzeichnis werden die Ausgabedateien die mit dem DITA Open Tookkit erstellt wurden dem Format entsprechend abgelegt 7 3 Umsetzung In den folgenden Abschnitten wird die Vorgehensweise zur Erstellung von DITA XML Dateien mit FrameMaker 8 beschrieben Die Inhalte des Benutzerhandbuchs liegen im Word Dateiformat vor F r die berf hrung der Inhalte von Word zu DITA gibt es mehrere M glichkeiten Die Word Dateien werden als HTML Dokument abgespeichert und mit dem DITA Open Toolkit in eine DITA XML Datei berf hrt Das DITA Open Tollkit stellt daf r das Werkzeug h2d zur Verf gung Die Word Datei wird in FrameM
41. ben Die Informationen werden in einem medienneutralen Format abgelegt das eine automatische Mehrfachverwen dung erm glicht vgl Kollmann und H sel 2007 S 81f Um die Wiederverwendung von Informationen zu erm glichen bedarf es einer sprachlichen Standardisierung der Texte Als Herausforderung zeigt sich in Single Source Projekten allerdings oft Kriterien f r die Modulgrenzen aufzustellen Dabei werden h ufig etablierten Gliederungskriterien aus Handb chern gew hlt z B Kapitel Unterkapitel Abschnitt Damit sind schnell Grenzen erreicht da diese Gliederungskriterien eher am Layout der Texte orientiert sind vgl Jakobs 2005 S 48 Einen L sungsansatz f r die Gliederungskriterien f r modularisierte Informa tionen bieten standardisierte Strukturen f r bestimmte Branchen Kapitel 4 XML Standards f r Dokumentationsstrukturen Mit linguistischem Grundwissen arbeiten dagegen Strukturierungsmethoden Kapitel 5 Strukturierungsmethoden 3 2 XML als Schl sseltechnologie Das Konzept des SSP ist unabh ngig von einer speziellen Technologie Single sourcing is a methodology not a technology Claris 2001 in Kollmann und H sel 2007 S 82 Demnach stellt sich die Frage nach geeigneten Technologien welche Technologien beim SSP Prozess zum Einsatz kommen bzw in welchem Format der Inhalte und das Layout abgelegt werden sollen Als grundlegende Technologie hat sich die extensible Markup Language XML du
42. by means of easily detachable muff couplings Dissipation of energy Energy absorption is ensured up to exhaustion of a 150 mm stroke on compression and a ma ximum load amounting to 1 100 KN Impact loads exceeding the absorption capacity of the col lapsible tube are transmitted to the underframe of the car Version 1 04 04 Page 3 5 COMPONENTS DESCRIPTION AND FUNCTION Figure 3 3 Characteristic of the collapsible tube 1 100 Vi Arbeitsaufnahme Energy absorption W J Z o 9 LE 2 x 0 Hub Stroke mm 150 3 3 4 Rubber cushion drawgear G The EFG type 3 rubber cushion drawgear provides regenerative energy absorption and dam ping characteristics that are sufficient to ensure normal coupling and operation Both draft and buff loads are cushioned by split rubber cushions which are rigidly housed in the unit and shear stressed as illustrated in figure Working mode of the cushion unit The maximum stro kes on compression and tension are 55 mm and 40 mm respectively see figure Characteristic of the rubber cushion drawgear D059 The cushioning unit is housed in a bearing brakket and provided with journals and maintenance free bushes to ensure horizontal slewability The EFG allows cardanic movements of the coupler as well as vertical and horizontal swing and torsional movements Vertical coupler support and height adjustment The mass of the coupler and the vertical load act
43. d Da keine Elemente fiir die Abbildungen zur Verf gung stehen wird dazu das Subelement lt stepxmp gt step example verwendet Innerhalb des lt stepxmp gt Elements ist fiir die Abbildung das lt fig gt Element erlaubt Die Abbildung wurde in einem separaten Topic erfasst und wird tiber den conref Mechanismus referenziert SCH_install coupler_ upler xml gt 0 1 22 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 oO ad Installing the coupler half lt 4 Make sure that the holes in the anchoring plate comespond to the hole configuration f shown in following figure Figure 1 1 Fitting dimensions for the coupler half in ml z pei e ed Strukturansicht z T i g A Installing the cou a B q f 4 f Anschlu ma e am Fahrzeug 4 Interface dimension on vehicle Support the coupler half with a lifting crane and straps and align it with the 4 plate f CAUTION Parts can get loose Seat engaging surfaces for screws and free from paint and grease in order to ensure correct tightening NOTE Forthe installation of the coupler half also refer to the current installa ments of the car builder Install the coupler half according to the current installation requirem ents of thi Lay the air pipe in such a way that it does not handicap the free horizontal a _ movement of the coupler half without being stretched or kinked Dok SCH_install 100 z Z 8 Textfluss A E step 1 von 2 i 80
44. d below and in chapter Parts list section Materials are used If any other material is used SCHAKU cannot be held liable for any resulting consequential damages Materials Used as KALTZINK HS 300 zinc Anti corrosive coat AUTOL TOP 2000 Anti corrosive RIVOLTA GWF Anti corrosive LOCTITE 7063 Cleaning degreasing Location Centring cone alternative AUTOL TOP 2000 Muff coupling collars Hollow space between screws and bores on lower muff of muff coupling Visible parts of hydrostatic buffer Threaded ends of screws and pins All surfaces Version 1 04 04 Page 5 14 MAINTENANCE 5 3 2 Location of greasing points Figure 5 1 Greasing points of the coupler shank a Collar for muff coupling AUTOL TOP 2000 5 3 3 Coating Tools and materials e air pressure gun sand blaster emery paper e primer paint and hardener Preparation Remove any foreign matter affecting the quality and adhesion of the painting material 2 De rusting has to be done by blast cleaning or by mechanic means complying with the purity degree SA 2 1 2 according to ISO 8501 1 standards 3 Apply the first priming coat not later than 4 hours after de rusting and degreasing Concerning the final coatings observe the specifications of the manufacturer The following parts and surfaces must not be painted if existing Rubber parts plastic caps and plastic hoods e stainless screws for the
45. dard Extensible Name and Adress Language 39 highlight Domain Mit der highlight Domain werden Elemente zur Verfiigung gestellt um Inhalte im Text auszeichnen zu k nnen denen keine spezielle semantische Bedeutung zukommt Die Elemente dienen ausschlie lich zur typografischen Auszeichnung von Inhalten Einige Elemente sind bereits aus HTML Hypertext Markup Language bekannt wie beispielweise das lt b gt Element zur Auszeichnung von Inhalten in Fettschrift oder das lt i gt Element zur Auszeichnung von Inhalten in Kursivschrift Weitere Elemente der highlight Domain sind lt u gt Inhalt unterstreichen lt tt gt unproportionale Schriftart lt sub gt Inhalt tiefgestellt lt sup gt Inhalt hochgestellt Ausblick auf die DITA Version 1 2 Um weitere thematische Bereiche zu erschlie en gibt es zahlreiche OASIS Arbeitsgruppen Eine f r die Technische Dokumentation wichtige Arbeitsgruppe ist das DITA Machine Industry Specialization Subcommittee Das Ziel der Unter arbeitsgruppe ist f r den DITA Standard 1 2 neue Domains und Topics zu entwickeln die auf die Anforderungen im Maschinen und Anlagenbau ausgerichtet sind Als Beispiel sei die hazard statement Domain genannt die Elemente und eine Struktur nach ANSI Z535 ISO 3864 f r Sicherheitshinweise vorgibt Derzeit k nnen Sicherheitshinweise nur mit dem lt note gt Element definiert werden Mit der DITA Version 1 1 w rden ber das type Attribut folgende Werte optio
46. dardisierten Datenaustausch Mit zunehmender Akzeptanz am Markt gibt es f r aktuelle Standards bereits Software Implementierungen oder sie werden mittels Plug in f r die jeweilige Software zur Verf gung gestellt Beispielsweise Content Management Systeme CMS haben sich entweder auf ganze Marktsegmente und deren Standardstrukturen spezialisiert z B SPEC 1000D bieten eine optionale Integration der Standardstrukturen oder stellen eine entsprechende Kompatibilit t durch Import und Exportfunktionen bereit vgl Kr ger und Ziegler 2008 S 15 4 2 SPEC 1000D Der Standard SPEC 1000D kurz S1000D wird seit 2003 gemeinsam von der AeroSpace and Defence Industries Association of Europe ASD und der Air Transport Association of America ATA entwickelt Dieser Standard war urspr nglich f r die Dokumentation f r milit rische Flugzeugger te und Flugsysteme gedacht Mit der Version 2 0 wurde die S1000D Spezifikation f r die Dokumentation f r Land und Seefahrzeuge erweitert vgl Hentrich 2008 S 81 14 S1000D wird bereits in der zivilen Luftfahrtindustrie Airbus Boeing eingesetzt und findet ihre Akzeptanz auch in anderen zivilen Bereichen vgl Rogge 2008 S 18 Die S1000D liegt derzeit in der Version 3 0 vor Die Spezifikation S1000D International specification for technical publications utilizing a common source database beschreibt den kompletten Dokumentationspro zess Sie umfasst standardisierte Dokumentstruktur
47. dem Quelldokument Abbildungen Die Abbildung und die dazugeh rige Abbildungsbeschriftung werden in einem Topic erfasst und soll in diesem Beispiel nach einem Handlungsschritt eingef gt werden Die Abbildung hat eine beschreibende Funktion und wird demzufolge in einem Concept Topic erfasst Da die Abbildungen ohne berschrift in dem Topic gespeichert werden sollen bleibt der Inhalt des lt title gt Elements leer Nach dem lt title gt Element wird das lt conbody gt Element eingef gt F r die Abbildungen mit den dazugeh rigen Informationen wird das lt fig gt Element verwendet Das lt fig gt Element umfasst unter anderen die Elemente lt image gt lt title gt und lt simpletable gt F r die Abbildung steht das lt image gt Element zur Verf gung Uber das href Attribut wird das Bild referenziert Nach einer Abbildung folgen in der Regel die Legende und die Abbildungsbeschriftung 78 In einer DITA Kurzreferenz beschreibt Closs 2007 das lt ig gt Element wie folgt Verwenden Sie das Element lt fig gt f r grafische Darstellungen Meistens enth lt lt fig gt Bild elemente es kann aber auch Textelemente enthalten lt fig gt hat ein optionales Element lt title gt f r eine beschreibende Bildunterschrift Closs 2007 S 197 Bei einer beschreibenden Bildunterschrift geht man davon aus dass sich die Bildunterschrift auch unter dem Bild eingliedern l sst Die DITA Struktur schreibt allerdings vor dass d
48. dy gt lt conbody gt lt p conref dateiname concept id p id lt p id p id gt Absatz Absatz lt p gt lt p gt lt body gt lt conbody gt lt concept gt Abbildung 9 Element eines Topics referenzieren Wird auf ein Element lt p gt verwiesen das sich innerhalb eines externen Topics befindet werden dem conref Attribut die Werte Dateiname der externen Datei die Topic ID und die ID des zu referenzierenden Elements lt p gt vergeben Der Dateiname und die Topic ID werden ebenfalls durch das Rautenzeichen getrennt Die Topic ID und die Element ID werden durch ein Slash getrennt Das Referenzieren eines Elements in einer Map erfolgt nach der gleichen Vorge hensweise nach dem Dateinamen der Map Datei folgt die ID des zu referenzierenden Elements in der Map Dateiname und Element ID werden durch das Rautenzeichen getrennt Die Verwendung des conref Mechanismus erfordert klare Vorgaben da das Inhaltsgeflecht un bersichtlich werden kann Es sollte festgelegt werden welcher Art die Inhalte sind die auf diese Weise eingebunden werden und wo die Einbindung stattfinden darf vgl Closs 2007 S 158 6 2 Map Eine umfassende Art Inhalte zu kombinieren bietet die Map ber die Map wird festgelegt welche Topics in ein Dokument aufgenommen werden und nach der Verarbeitung im Ausgabemedium zur Verf gung stehen sollen Die Topics k nnen in einer beliebigen Reihenfolge hierarchisch angeordnet werde
49. e Berlin Offenbach VDE Verlag 1994 ISBN 3 8007 1987 8 Hurst Sophie 2006 XML im Wartestand Umfrage zu Tools und Prozessen in Technischen Redaktionen Produkt Global 2006 03 S 10 Jakobs Eva Maria et al 2005 Schreiben am Arbeitsplatz Wiesbaden VS Verlag f r Sozialwissenschaften 2005 ISBN 3 531147 32 3 Kaspar Christian 2006 Individualisierung und mobile Dienste am Beispiel der Medienbranche Ans tze zum Schaffen von Kundenmehrwert G ttingen Universit tsverlag G ttingen 2006 ISBN 9 783 938616 53 6 Kollmann Tobias und H sel Matthias 2007 Web 2 0 Trends und Technologien im Kontext der Net Economy Essen DUV Verlag 2007 ISBN 978 3 835008 36 6 Kr ger Klaus 2008 Adobe FameMaker 8 Dokumente formatieren PDF Dateien generieren XML und DITA verarbeiten Heidelberg Berlin Springer Verlag 2008 ISBN 978 3 540 77904 9 Kr ger Manfred 2007 Systeme prototypisch erproben Produkt Global 2007 03 S 29 94 Ley Martin 2006 Aspekte der Informationsstrukturierung Online April 2006 http www tekom de index_neu jsp url servlet ControllerGUT action voll amp id 18 71 Abruf 03 06 2008 Muthig J rgen und Sch flein Armbruster Robert 2008 Funktionsdesign methodische Entwicklung von Standards Buchverf J rgen Muthig Standardisierungsmethoden f r die Technische Dokumentation L beck Verlag Schmidt R mhild 2008 Bd 16 Rogge J rg 2008 ADL SCROM und ASD S1000D
50. e DITA Map wird mit dem Befehl DITA gt Neue Datei gt Neu lt map gt erstellt Der Titel wird ber das Attribut title des Wurzelelements lt map gt vergeben Demnach ist der Titel im Ausgabemedium nicht sichtbar Die Topics werden ber das lt topicref gt Element referenziert und k nnen hierarchisch angeordnet werden Semipermanent c0 35167 ditamap eth RR BY yw Bb b 7 Js B To m r J E Strukturansicht map T topicret Semipermanent coupler half 2 03 General information for the use of the manual SCH_Gl x Safety precautions SCH_SP xml General informati Components Description and function SCH_DES xm Technical data SCH_DES_techdata xml Function SCH_DES_function xml topicret Safety precaution Design and subassemblies SCH_DES_design xml opicret SCH_figure_coupler half xm Ait pipe connection D SCH_DES_d xm h Components De SCH_figure_d xml Coupler shank with collapsible tube F SCH_DES fm topicreflabel Technical data S Connection SCH_DES_f_connect xml Dissipation of energy SCH_DES_f_dissipation Tropicret SCH_figure_f_character xml Rubber cushion drawgear 6 SCH_DES_g xmh Function SCH_D Vertical coupler support and height adjustment SCH_figure_g_character xml Connection to coupler shank SCH_D
51. e Saane seii anne 53 6 6 2 DITA Anwendungen uaun san 59 Dokumentationserstellung mit DITA in Adobe FrameMaker 8 65 7 1 Ausgangssituation und Festlegungen an ee 65 7 1 1 Analyse der Dokumentation cece aia aia ia a a 65 7 1 2 Modularisierung der Informationen s sssssesesssesseeressssssretesesssstrttetsssntrtretsssneerrerssssrrrreessse 70 7 13 Festlegungen zur Dateibezeichnung aneiens iieii pia 71 72 Vorbereitung naar a e t 73 ha UMSETZUNG user r a a E E ERR 74 7 3 1 Erstellender Topiesi nane asien eis 75 7 3 2 Erstellen einer DITA Map und Generieren eines FrameMaker Buches 84 7 3 3 Weiterverarbeitung der DITA XML Deteien ununnnesmesenensenennensensnnensensnnennennnnn 85 ZA AUSWEITUNG un nee besfesss chutes sah cvessvovsbe fasts dasedvessadeetyassseevensactsisdedeetsedretyaesetssstedtebeadigs 87 8 Zusammenfassunn a see 91 Literaturverzeichnis anni nenn doirt iseit Sss 93 Eidesstattliche Erkl rung u sr2sn u near 96 PAN AN Os euer A II Abkurzungsverzeichnis ANSI ANT API ASD ATA DITA DSSSL DTD DTP EDD HTML ID IMAP ISO mumasy OASIS PDF SGML RTF W3C XML XSL XSL FO XSLT American National Standards Institute Another Neat Tool Application Programming Interface AeroSpace and Defence Industries Association of Europe Air Transport Association of America Darwin Information Typing Architecture Document Style Semantics and Specification Language Document Ty
52. e car underframe must be plane and rectangularly aligned to the underframe both vertically and horizontally Check the level surface and rectangular position of the plate according to ISO 2768 K Adjust if necessary CAUTION Centre of hole is configuration on anchoring plate is identical with centreline of coupler half Use a level to check and adjust horizontal alignment of longitudinal trans versal axes Make sure that there is sufficient space behind the anchoring plate for the tools to be used 7 2 3 Installing the coupler half 1 Make sure that the holes in the anchoring plate correspond to the hole configuration shown in following figure Version 1 04 04 Page 7 19 MOUNTING AND REPAIR INSTRUCTIONS Figure 7 1 Fitting dimensions for the coupler half in mm 525 440 0 3 285 200 0 3 AnschluBmaBe am Fahrzeug Interface dimension on vehicle 2 Support the coupler half with a lifting crane and straps and align it with the anchoring plate CAUTION Parts can get loose Seat engaging surfaces for screws and nuts must be free from paint and grease in order to ensure correct tightening ar NOTE For the installation of the coupler half also refer to the current installation require ments of the car builder 3 Install the coupler half according to the current installation requirements of the car builder Lay the air pipe in such a way that it does not handicap the free horizontal and vertical movement of the
53. e und ihre Bedienung insbesondere wenn spezifische Anpassungen durchgef hrt wurden Beschreibung der messbaren Qualit tsma st be f r die Arbeitsergebnisse Beschreibung der Gestaltungsregeln bez glich der Sprache Wortwahl Terminologie Inhalt und Struktur Gliederung Modularisierung Die Ziele die bei Einhaltung des Redaktionsleitfadens erreicht werden sind ein hoher Qualit tsstandard Konsistenz und Verst ndlichkeit ber alle Dokumentatio nen und Dokumentationsarten hinweg sowie ein eindeutiger Informationstransport zum Endkunden bzw Anwender Erg nzt werden diese Zielsetzungen durch einen hohen Grad der Wiederverwendung von Informationen vgl Enders und Wolff 2008 S 18 Der Informationsaustausch zwischen Dienstleister Zulieferer Auftraggeber Endkunde w hrend des Produktlebenszyklus wird durch eine medienneutrale Datenhaltung vereinfacht Erstrebenswert ist das nicht zuletzt weil sich wie bereits beschrieben vielfach Probleme mit Medienbr chen und propriet ren Formaten ergeben 3 Wiederverwendung von Informationen Technische Informationen m ssen h ufig f r unterschiedliche Medien bereitgestellt f r mehrere Zielgruppen aufbereitet und in unterschiedlichen Dokumenten verwendet werden Bei einer Umfrage zu den Prozessen in Technischen Redaktionen wird als gr te Herausforderung die Wiederverwendung von Inhalten mit 63 4 Prozent genannt vgl Hurst 2006 S 10 Diese Bedeutung der Wiederverwendun
54. ef gt lt chapter href gt lt topicref href gt lt chapter gt lt part gt lt appendix href gt lt appendix gt lt backmatter gt lt backmatter gt lt map gt Abbildung 12 Grundstruktur einer Bookmap 46 Die in der Grundstruktur abgebildeten Elemente definieren die Bl cke eines Buches Die Informationen in den einzelnen Bl cken werden durch weitere Elemente spezifiziert Der Buchblock in dem sich der eigentliche Inhalt befindet wird durch die Elemente lt part gt lt chapter gt und lt topicref gt strukturiert vgl Hentrich 2008 S 202f 6 3 Metadaten Neben den Strukturelementen f r die Inhalte sind in DITA auch Elemente f r Zusatzinformationen Metadaten definiert Die Metadaten sind in den Ausgabeme dien in der Regel nicht sichtbar und enthalten interne Informationen wie vgl Closs 2007 S 38 G ltigkeit zeitlich rtlich inhaltlich Bearbeitungsstand im Entwurf abgenommen archiviert Herkunft Autor Bereich Zugeh rigkeit Thema Bereich Produkt Weiterhin k nnen anhand von Metadaten Verarbeitungsprozesse elektronischer Dokumente gesteuert werden Metadaten die den Verarbeitungsprozess einer DITA XML Datei beeinflussen werden ber Attribute vergeben Die folgenden Abschnitte befassen sich mit den beiden Typen von Metadaten 6 3 1 Metadaten f r die Verwaltung Metadaten werden ben tigt um Inhalte effizient verwalten und wieder ver
55. emente und einige zus tzliche FM spezifische Eingliede rungselemente f r die Erstellung von FM B chern In der Anwendungsdefinition der DITA Book FM wird daher auf die FM eigene Datei dita book fm dtd verwiesen 62 EDD Element Definition Document FrameMaker bietet f r jede DITA Anwendung eine EDD In der Standardausf h rung werden die topi edd dita map edd und die book edd fm angeboten Fiir eigene Anpassungen wird von FrameMaker empfohlen Sicherheitskopien anzulegen und die angepassten Dateien im Projektordner abzulegen vgl Kr ger K 2008 S 248 Die EDDs f r die DITA Anwendungen bilden die Struktur der jeweils zugrundelie genden DITA DTD ab Das hei t die Anordnung und Hierarchie der Elemente in einer EDD sowie deren Attribute hneln den Strukturinformationen einer DTD der DITA XML Dokumente ZE II iis BSD B v TimesNewRomen jij Srikiran xe chapter edd fm ection Copyright and legal information 0 Element Container topic 1 General rule title titlealts shortdesc prolog body related links topic c4 Topic elements f task reference These elements define the struct 4 Valid as the highest level elem ent dta z Attribute list b topic 3 1 Name id Unique ID Required title 2 Name conref String Optional teatis 3 Name platform String Optional BR 4 Name product String Optional 5 Name audience String Optional saarch lie 6 Name otherprops String Optional shondese 7 Name imp
56. en kommunikativ funktionalen und strukturellen grammatischen und thematischen Merkmalen beschreiben vgl Brinker 2001 S 129ff Diese Differenzierung wird auf dieser oberen Ebene des Funktionsdesigns bei der Standardisierung der Informationsprodukte vorgenommen 1 Quelle Sch flein Armbruster 2006 S 15 23 In der Technischen Dokumentation typische Informationsprodukte die es konsistent zu strukturieren und voneinander abzugrenzen gilt sind beispielsweise Technische Daten Wartungsanleitung Betriebsanleitung Produkt und Einzelteilka taloge usw vgl Muthig und Schaflein Armbruster 2008 S 48 Diese Ebene definiert die Zielgruppe und die Art des Gebrauchs der zu erstellenden Technischen Dokumentation Zudem werden das Medium und die Struktur festgelegt Ziel auf dieser Ebene ist eine vorgefertigte Makrostruktur bereit zu stellen in der die Inhalte vom Autor klar platziert und vom Anwender sicher aufgefunden werden k nnen vgl Hentrich 2008 S 84 Sequenzmuster Sequenzmuster sind im Funktionsdesign die identifizierten strukturell vorgefertigten Raster auf mittlerer Ebene Sequenzmuster setzen sich aus Funktionalen Einheiten zusammen und sind Strukturbausteine aus denen Informationsprodukte aufgebaut sind vgl Muthig und Sch flein Armbruster 2008 S 50 Leitend fiir die Festlegung von Sequenzmustern ist der Sequenzierungsaspekt der von handlungslogischen und didaktischen Prinzipien und auch von i
57. en Auszeichnung zur Verf gung Diese Elemente werden thematisch in Domains zusammengefasst und sind nicht an Topic Typen gebunden Mit der DITA Version 1 1 stehen sieben Domains zur Verf gung deren Schwerpunkt auf die semantische und typografische Auszeichnung von Inhalten aus der Software Dokumentation ausgerichtet ist vgl Hentrich 2008 S 22 Im Folgenden werden die Domains der Elemente zur semantischen Auszeichnung von Inhalten mit den zugeh rigen Modul Dateien und deren Funktion nur genannt Die Elemente zur semantischen Auszeichnung werden in Hentrich 2008 S 177 183 ausf hrlich beschrieben In DITA stehen folgende Domains der Elemente zur semantischen Auszeichnung zur Verf gung vgl Fritz et al 2008 S 13 indexing Domain indexingDomain mod beinhaltet Elemente zur Auszeichnung von Indexeintragen und fiir Verweise auf andere Indexeintrage seit DITA 1 1 programming Domain programmingDomain mod beinhaltet Elemente zur Auszeichnung der Syntax einer Programmiersprache software Domain softwareDomain mod beinhaltet Elemente zur Auszeichnung von Operationen einer Software user interface Domain uiDomain mod beinhaltet Elemente zur Auszeichnung der Bedienelemente einer Software utilities Domain utilitiesDomain mod beinhaltet Elemente zur Auszeichnung von Image Maps xNal Domain xnalDomain mod beinhaltet Elemente zur Auszeichnung von Namens und Adressinformatio nen nach dem xNal Stan
58. en und Skripts zur Generierung von Ausgabedokumenten und auch die Definition zur Planung von Dokumentati onsprojekten zu konkreten Arbeitsabl ufen zum Informationsaustausch bis hin zur Freigabe von Dokumenten vgl Ferlein 2005 S 62 Bei der Entwicklung des S1000D Standards f r die Strukturierung technischer Dokumentationen wurde explizit komponentenorientiert gedacht S mtliche Informationen des zu dokumentierenden Ger tes werden entsprechend der Komponentenstruktur in Datenmodulen erfasst deren Klassifikationssystem die Datenmodule eindeutig bezeichnet und sie in die Komponentenstruktur der Gesamtsystems einordnet vgl Ziegler und Kr ger 2008 S 25 Die S1000D beschreibt die Erstellung von kleinen in sich abgeschlossenen Informationseinheiten die sogenannten Datenmodule Data Module DM die in einer allgemeinen Quellendatenbank Common Source Data Base CSDB gespeichert verwaltet und gepflegt werden Die Nutzung von SGML und XML gew hrleistet ihre Unabh ngigkeit von spezifischer Hard und Software Jedes Datenmodul verf gt ber eine Identifizierungs und Statussektion IDSTA TUS sowie einen Inhaltsteil CONTENT Ein Datenmodul ist ber einen Datenmodul Code Date Module Code DMC eindeutig identifizierbar Dies garantiert eine eindeutige Zuordnung eines Datenmoduls zu einem bestimmten Projekt Der Datenmodul Code gibt weiterhin ber einen definierten Systemaufbau Auskunft welche Komponenten oder Baugruppen inn
59. er othertype warning id SCH_warning_health class topic note note jt men Surfacescan be damaged Do not note bikses Risk of corrosion of coupler An Ben esses Risk of lubricating film break L Dok SCH_safety_precautions xml Textfluss A 120 z ZAR gt 3 Textfluss A E note 1 von 2 100 z ZAR gt Abbildung 35 Sicherheitshinweise im Quelldokument Zus tzlich zu den Allgemeinen Sicherheitshinweisen m ssen Sicherheitshinweise unmittelbar vor einen Handlungsschritt der eine Gef hrdung mit sich bringen k nnte stehen Wie bereits beschrieben kann das Task Topic beliebig viele Handlungsschritte lt step gt Elemente enthalten aber nur einen Handlungsblock 82 lt steps gt Element Innerhalb des Handlungsblocks also des lt steps gt Elements steht nur das lt step gt Element zur Verfiigung Innerhalb des lt step gt Elements k nnen nach dem lt cmd gt Element f r den Handlungsschritt weitere Elemente folgen Die M glichkeit einen Sicherheitshinweis unmittelbar vor einen Handlungs schritt zu stellen ist nicht gegeben Damit die Sicherheitshinweise dennoch eingef gt werden k nnen und es optisch richtig aussieht wurde daf r das lt stepxmp gt Element verwendet und damit mehr oder weniger zweckentfremdet SCH_i install coupler_ upler xml gt a o i a WISUIC Up Maye om rom zeuy Interface dimension on vehicle t Be E Mh ait cnt T a bone coupler half
60. erenzen lt topichead gt berschrift ohne Referenz auf ein Topic lt topicmeta gt Metadaten der Map lt topicref gt Verweis auf ein Topic Die Topics werden ber das lt topicref gt Element referenziert ber das href Attribut wird auf das Topic verwiesen 45 lt xml version 1 0 encoding UTF 8 gt lt DOCTYPE map PUBLIC OASIS DTD DITA Map EN map dtd gt lt map id map id title Maptitel gt lt topicref href topic xml gt lt map gt Abbildung 11 Topic in einer DITA Map referenzieren lt topicref gt Elemente k nnen dabei in beliebiger Tiefe verschachtelt werden Auf diese Weise k nnen die Inhalte hierarchisch angeordnet werden Im Inhaltsverzeich nis werden dann die Titel der Topics und die in der Map festgelegte Struktur abgebildet 6 2 2 Bookmap Mit DITA 1 1 wurde die sogenannte Bookmap eingef hrt die eine Spezialisierung der Map darstellt Mit der Bookmap werden die typischen Bestandteile von B chern ber cksichtigt es wurden beispielsweise Elemente f r die Titelseite oder das Vorwort eingef hrt vgl Hentrich 2008 S 201 Die Bookmap wird ber das lt bookmap gt Element definiert das Elemente f r die Buchbestandteile enth lt wie Titelblatt Inhaltsverzeichnis Vorwort Inhalt Anhang Index Glossar vgl Hentrich 2008 S 202 lt bookmap id bookmap id gt lt booktitle gt lt booktitle gt lt fontmatter gt lt fontmatter gt lt part hr
61. erf gung gestellt In einem Topic stehen diese Elemente im lt prolog gt Element zur Verf gung das vor dem lt body gt Element stehen darf In einer Map k nnen Metadaten innerhalb des lt topicmeta gt Elements erfasst werden das vor dem lt topicref gt Element stehen darf In der folgenden Abbildung sind einige m gliche Metadaten dargestellt die f r die Verwaltung in einem Topic erfasst werden k nnen 48 AUTHOR MAREN STYPKA Maren Stypk a PUBLISHER TUV SUD RAIL GMBH COPYRIGHT 2004 COPYRIGHT HOLDER VOITH TURBO SCHARFENBERG GMBH amp Co KG CREATION DATE 2008 08 07 Rev DATE 2008 11 28 FREELY DISTRIBUTABLE INTENDED AUDIENCE USER PRODUCT NAME SEMIPERMANENT COUPLER HALF VERSION RELEASE MODIFICATION 1 2008 12 13 2008 08 12 BRAND SCHAKU T V SUD Rail GmbH primary SMBR HABN 2004 2008 08 07 To be read and understood before putting coupler into op 2008 11 28 9 i CAUTION Risk of damage to coupler halves Mak halves are compatible before connection CAUTION Risk of damage to air pipes When twd connected with muff coupling in horizontal position muff coupling vertically Abbildung 13 Metadaten in einem Topic 6 3 2 Metadaten fur die Verarbeitung Bei elektronischen Dokumenten k nnen ber die Metadaten Inhalte ausgefiltert filtering oder farblich grafisch gekennzeichnet flagging werden In DITA wird dieser Prozess als bedingte Verarbeitun
62. erhalb des Projektes betroffen sind und welche Art von Arbeiten durchgef hrt wird vgl Rogge 2008 S 18 15 Zus tzlich zur Definition der Datenmodule wird in S1000D festgelegt wie die Datenmodule zu verwenden sind wie Grafiken und Inhalte zu gestalten sind welchen sprachlichen und semantischen Regeln und zu verwenden sind und wie die Datenmodule zur eindeutigen Identifizierung kodiert werden miissen vgl Hentrich 2008 S 83 Weiter legt S1000D fest welche Handbiicher oder Publikationen zu produzieren und wie sie inhaltlich zu gliedern sind Aus der Gesamtheit aller Datenmodule werden die fiir den Nutzer notwendigen Publikationen zusammengestellt und als datenbankba sierte elektronische Publikation bereitgestellt Die Datenmodule k nnen aus der Quelldatenbank aufgerufen und angezeigt werden und f r verschiedene Publikatio nen mehrfach verwendet werden vgl Rogge 2008 S 18 Ziegler und Kr ger 2008 kennzeichnen S1000D als drei schichtiges Informations modell Komponentenstruktur des zu dokumentierenden Systems bestimmt die Komponentenstruktur der Daten Datenmodul Code verbindet die eindeutige Bezeichnung eines Datenmoduls dessen Einordnung in die Komponentenstruktur des Systems und die Ver wendung in bestimmten Publikationen Die Publikationen sind entsprechend ihrer Nutzungsziele bedingungen und situationen strukturiert Prinzipiell k nnte S1000D auch in anderen Branchen eingesetzt werden Die Ko
63. erst tzung zur Bucherstel lung auch eine verbesserte Erweiterbarkeit von Daten angeboten 33 Im Folgenden sollen die wesentlichen Anderungen vorgestellt werden vgl Bergert 2007 S 1 Bookmap Spezialisierung die buchspezifische Informationen ber cksichtigt Glossentry Spezialisierung f r Glossareintr ge in B chern Indexing Spezialisierungen Elemente f r Indexeintr ge in B chern f r Seitenbereiche und Sortierung Verbesserungen f r die Skalierung von Grafiken neues Element f r Zusammenfassungen lt abstract gt Spezialisierungsunterst tzung f r neue globale Attribute und bedingte Verarbeitungen ditaval Element f r die Einbeziehung DITA fremder XML Strukturen lt foreign gt Elemente f r die Integration neuer und unbekannter Inhalte lt data gt und lt unknown gt In den folgenden Abschnitten soll das Konzept der DITA Architektur ausf hrlicher beschrieben werden 6 1 Topics Ein Topic ist eine in sich abgeschlossene m glichst kontextunabh ngige Informati onseinheit die ein Thema abhandelt Dieses Thema kann mit einer berschrift kompakt beschrieben werden vgl Closs 2008 S 77 Topics k nnen beispielsweise Texte Bilder Videos oder Flash Animationen enthalten Hentrich 2008 S 64 fasst folgende Eigenschaften eines Topics zusammen Ein Topic beantwortet vollst ndig eine Frage Ein Topic kann f r sich allein stehen Aufein Topic kann einzeln zugegrif
64. estehenden Inhalten sollen mit FrameMaker wiederverwendbare Module nach dem DITA Konzept erstellt und f r die Wiederverwendung bereitgestellt werden F r die Umsetzung ist eine systematische Vorgehensweise notwendig Anhand der bestehenden Inhalte m ssen die Ausgangssituation klar definiert und daraus Festlegungen getroffen werden Dazu wurden zun chst Informationsart Kontext und Struktur der Inhalte analysiert In den folgenden Abschnitten wird erl utert wie bei der Erstellung von XML Dateien nach dem DITA Standard die Ausgangssituation analysiert wurde und welche Festlegungen sich daraus ableiten lie en 7 1 1 Analyse der Dokumentation Das Benutzerhandbuch ist bereits klar und einheitlich nach logischen und visuellen Gesichtspunkten in Anlehnung an die Methode Funktionsdesign strukturiert 65 Die Bestandteile Informationsprodukte des Benutzerhandbuchs und ihre Anordnung sind bereits vorgegeben Die Dokumentstruktur Makrostruktur ist am Produktlebenszyklus orientiert In der folgenden Abbildung zeigt die Makrostruktur des Benutzerhandbuchs Sicherheits hinweise Abbildungs verzeichnis Inhalts verzeichnis Titelblatt Abbildung 22 Makrostruktur des Benutzerhandbuchs Die Informationsprodukte und lassen sich in folgende drei Informationsbereiche einordnen Produktbezogene Informationen enthalten informative beschreibende anleitende und warnende Inhalte Allgemeine Sicherhe
65. f with a lifting crane and straps and align it with the anchoring plate 2 CAUTION Parts can get loose Seat engaging surfaces for screws and nuts must be free from paint and grease in order to ensure correct tightening a NOTE For the installation of the coupler half also refer to the current installation requirements of the car builder 3 Install the coupler half according to the current installation requirements of the car builder 4 Lay the air pipe in such a way that it does not handicap the free horizontal and vertical movement of the coupler half without being stretched or kinked 2 CAUTION Air pipe may leak Use soap solution to check connection and screw fitting of air pipe for leakage 5 Use a soap solution to check the connection and screw fitting of the air pipe for leakage 6 Check the vertical alignment of the coupler half see section 5 1 2 7 Connect the earth strands at their fixing points see Figure 1 3 1 e between the coupler shank and the bearing bracket and e between the bearing bracket and the rubber cushion unit Removing the coupler half Before removing the coupler half support it with a lifting crane The coupler half is to be removed in reverse order of installation For details refer to the individual sections of the components described in this chapter Shipping The coupler half will be delivered completely mounted on pallets or in boxes These have to be adequately secured in order to prevent s
66. fen werden Die DITA Topics sind nach Informationsart typisiert bzw klassifiziert Nach der IMAP Methode k nnte demzufolge jedem Topic Typ eine andere Fragestellung 34 zugeordnet werden was sich entsprechend auf die Inhalte der einzelnen Topics auswirkt DITA stellt mit der Version 1 1 standardm ig f nf Topic Typen zur Verf gung Der Grundtyp ist das generische Topic Topic Aus dem generischen Topic sind die Topic Typen Aufgabe Task Konzept Conzept und Referenz Reference spezialisiert Der Typ Konzept wurde weiter zum Topic Typ Glossar Glossentry spezialisiert Generisches Topic ee Task Concept Reference Glossentry Abbildung 2 Die vorgegebenen Topic Typen von DITA Dem generischen Topic ist keine bestimmte Informationsart bzw Fragestellung zugeordnet Es kann somit als Container f r die Inhalte verwendet werden denen ein vorgegebener Topic Typ nicht zugeordnet werden kann bzw wenn keine weiteren Topic Typen f r diese Inhalte durch Spezialisierung erzeugt werden Bei der Verwendung des generischen Topics sollte dennoch eine Fragestellung beantwortet werden k nnen vgl Hentrich 2008 S 20 Das Task Topic ist f r Handlungsanweisungen gedacht und beschreibt den vollst ndigen Ablauf einer bestimmten Handlung Der in sich abgeschlossene Handlungsablauf erf llt damit die Voraussetzung f r ein Topic Das Task Topic beantwortet die Frage wie der Anwender eine bes
67. finiert werden zum einen die Standardisierung der Dokumentationen und zum anderen die Modularisierung von Informationen Letzteres um produkt anwender oder auch kundenspezifische Dokumentationen erstellen zu k nnen Die Standardisierung von technischen Informationen umfasst unterschiedliche Ebenen Kr ger und Ziegler 2008 S 12 unterteilen in folgende Standardisierungs ebenen Inhaltliche Standardisierung einheitliche Terminologie und sprachliche Formulierung Strukturelle Standardisierung einheitliche Strukturen von Makro bis Mikroebene der S tze oder W rter Standardisierte Formate Verwendung einheitlicher Datenformate Standardisiertes Layout einheitliche Gestaltung F r die Einhaltung der Qualit tsma st be k nnen Technische Redakteure bei der Erstellung der Technischen Dokumentation durch einen Redaktionsleitfaden unterst tzt werden Er gew hrleistet die Einhaltung einer einheitlichen Struktur und Gestaltung gegebenenfalls f r verschiedene Ausgabemedien Der Redaktionsleitfaden beinhaltet eindeutige und verbindliche Vorgaben Festlegungen und Entscheidungen die notwendig sind um qualitativ hochwertige Dokumentationen zu erstellen vgl Romberg 2000 S 43 Folgende Aufgaben eines Redaktionsleitfadens fasst Romberg 2000 zusammen Systematische Beschreibung der Arbeitsabl ufe und Verantwortlichkeiten der Prozesse innerhalb einer Dokumentationsabteilung Beschreibung der verwendeten Werkzeug
68. g conditional processing bezeichnet vgl Hentrich 2008 S 130 In den Topics werden daf r in allen Elementen die Attribute audience Zielgruppe platform Betriebs oder Hardwaresystem importance Dringlichkeit product Produkt oder Produktversion rev nderungszust nde otherprops Sonstiges und status aktueller Bearbeitungsstand zur Verf gung gestellt 49 Die DITA Version 1 1 stellt zusatzlich das Attribut props bereit Das props Attribut ist ein generisches Attribut das als Basis fiir eine Spezialisierung verwendet werden kann vgl Hentrich 2008 S 214 Die bedingte Verarbeitung von Inhalten ist seit der DITA Version 1 1 m glich Sie wird tiber eine sogenannte ditaval Datei gesteuert In dieser Datei wird festgelegt welche Attribute und Werte fiir die bedingte Verarbeitung verwendet werden sollen Eine ditaval Datei ist eine XML Datei mit dem Wurzelelement lt val gt Dieses Element umfasst das lt prop gt Element f r das Filtern und Kennzeichnen der Inhalte und das lt revprop gt Element fiir die Definition zur Verarbeitung vgl Hentrich 2008 S 215 Um Verarbeitungsprozesse von Maps zu steuern werden in den Map Elementen beispielsweise die Attribute vgl Hentrich 2008 S 198 collection type Beziehung der Topics zueinander format Formate der Datei pdf html usw print Ausgabe im PDF Format toc Inhaltsverzeichnis zur Verf gung gestellt
69. g lie e erwarten dass dies mit dem Einsatz von XML geschieht Weitere Ergebnisse der Umfrage zeigen allerdings dass Microsoft Word mit ber 56 Prozent und Adobe FrameMaker mit ca 44 Prozent am h ufigsten eingesetzt werden vgl Hurst 2006 S 10 Nach welchen L sungsans tzen die Wiederverwendung von Informationen erfolgen kann fasst Hentrich 2008 S 95 wie folgt zusammen Inhalt wird f r ein Medium erstellt und f r andere Medien formatiert Inhalt wird f r ein Medium erstellt aber medienneutral formuliert Inhalte werden f r jedes Medium unabh ngig voneinander erstellt Inhalte werden medienneutral erstellt und anschlie end gekennzeichnet Welche L sung angewendet wird h ngt von den technischen M glichkeiten und der Zielgruppe ab Der Wunsch sei allerdings eine gemeinsame Quelle die zentral konsistent und redundanzfrei erstellt und gepflegt wird Aus dieser Quelle sollen dann alle Informationen nach Bedarf zusammengestellt und produziert werden Single Source Publishing vgl Closs 2008 S 1 3 1 Single Source Publishing Der Grundgedanke von Single Source Publishing SSP ist die Wiederverwendung bzw Mehrfachverwendung von Informationen Die Informationen werden einmal in Modulen erstellt um daraus verschiedene Publikationen f r verschiedene Zielmedien auszugeben Eine Wiederverwendung der Informationen setzt eine klare Trennung von Inhalt und Layout voraus Das Layout wird durch das Zielmedium vorgege
70. g die kommunikative Funktion der Funktionalen Einheiten optimal unterst tzen soll vgl Sch flein Armbruster 2006 S 22 F r die Festlegung von beispielsweise Abst nden bedeutet dies geringe Abst nde signalisieren thematische und oder funktionale Zusam menh nge gr ere Abst nde verdeutlichen dass Thema oder Funktion der Textab schnitte wechseln Der funktionale Ansatz spiegelt sich auch in der Benennung der Auszeichnungsele mente wider Soll beispielsweise eine Meldung auf dem Display eines Ger tes dargestellt werden kann dazu das Auszeichnungselement Displaytext definiert werden Weniger sinnvoll w re eine layout orientierte Benennung von Auszeich nungselementen beispielsweise nach Formatvorlagen wie f r den Displaytext Einzug 2 cm fett Eine solche Benennung ist zwar konsistent kann aber Inkonsistenten in ihrer Verwendung verursachen Beispielsweise kann die Auszeichnung Einzug 2 cm fett auch f r andere Informationselemente verwendet werden 28 5 3 Information Mapping Einen weiteren methodischen Ansatz um Informationen zur strukturieren bietet Information Mapping IMAP IMAP ist eine Methode zur Analyse Strukturierung und Darstellung von Informationen die von Robert E Horn entwickelt wurde Sie ber cksichtigt lernpsychologische Gesichtspunkte und Erkenntnisse aus der Gehirnforschung ber die Wahrnehmung von Informationen vgl B hler 2008 S 144 Wie auch bei der Funkt
71. ge Anwendungsdefinition giiltig ist Darauf folgen Verweise auf das giiltige Template auf die DTD und auf die Lese Schreibregeln Read write rules der entsprechenden Anwendung Zus tzlich werden ber DOCTYPE die Wurzelelemen te der Anwendung angegeben Beim ffnen einer DITA XML Datei registriert FrameMaker das Wurzelelement und verwendet automatisch die giiltige Anwendung Werden Wurzelelemente fiir weitere Anwendungsdefinitionen mehrfach verwendet muss beim Offnen einer DITA XML Datei die entsprechende Anwendung ausgewahlt werden F r die Anderungsverwaltung bietet FrameMaker die Funktion Text nderungen auch im XML Format zu speichern Mit der Verarbeitungsanweisung Output Text PI des Elements Conditional Text wird definiert wie FrameMaker XML Dateien beim Import oder Export bersetzt die sogenannte bedingte Texte enthalten Der Verarbeitungsprozess f r bedingte Texte ist standardm ig in jeder XML Anwendung aktiviert ber Entity locations werden die in einer DITA Anwendung eingebundenen DTDs referenziert F r den Zugriff auf eine DTD wird ber Public ID public identifier zun chst der ffentliche Bezeichner nach dem Schema owner keyword description language angegeben und ber Filename wird die entsprechende DTD identifiziert DITA DTD Die DITA DTDs sind modular aufgebaut Der modulare Aufbau erm glicht die Wiederverwendung einzelner Teile der Spezialisierungshierarchie und auch eine Erweiterung
72. gen Datenaustausch und die Weiter Verarbeitung der strukturierten Inhalte Der Datenaustausch kann technisch sowohl unternehmens bergreifend realisiert sein zum Beispiel zwischen Zulieferern und produzierenden Abnehmern als auch innerhalb eines Unternehmens zum Beispiel zwischen verschiedenen Abteilungen eines Unternehmens Weitere Vorteile eines Standards liegen in der semantischen Einheitlichkeit der Strukturen Die Struktur wird von allen Seiten gleich verstanden und den Struktur elementen wird der gleiche Informationstyp zugeordnet Auf diese Weise wird eine systemgest tzte Verarbeitung der Informationen erleichtert vgl Kr ger und Ziegler 2008 S 14 13 Nach Kr ger und Ziegler 2008 wurden in der Praxis bisher wenige Szenarien realisiert bei denen der Austausch von standardisierten Dokumentationen und Produktinformationen zwischen Unternehmen stattfindet Die Ursache liege zum gro en Teil in der Organisation Kleine und auch mittlere Zulieferbetriebe haben h ufig keine technischen oder personel len Kapazit ten um XML strukturierte Dokumente zu erstellen Zudem werden diese vom Abnehmer au er im Bereich der Luftfahrt und Automobilindustrie aus unterschiedlichen Gr nden noch nicht gefordert Kr ger und Ziegler 2008 S 13 Die derzeitige Entwicklung standardisierter Dokumentationsstrukturen und vor allem der entsprechenden vereinfachten Anwendungen geben dagegen deutliche Impulse f r einen stan
73. gslogi schen Reihenfolge oder baugruppenorientiert zusammengestellt Den einzelnen Informationsprodukten wurden K rzel zugewiesen General information GI Safety precautions SP Components Description and function DES Operating instructions OI Maintanencs MT Troubleshooting TS Mounting and repair instructions MRI Parts list PL Die Inhalte werden entweder nach ihrer kommunikativen Funktion mit einer Kurz beschreibung gekennzeichnet oder nach der Baugruppe mit dem vom Hersteller festgelegten Buchstaben Beispielsweise wurde der Baugruppe Air pipe connection der Buchstabe D zugeordnet Die Datei mit einer Baugruppenbeschreibung wird dann wie folgt gekennzeichnet d_description Baugruppe_Kurzbeschreibung kommunikative Funktion Bezieht sich ein Inhalt beispielsweise auf die gesamte Kupplung z B Technische Daten techdata Kurzbeschreibung kommunikative Funktion E Projects contents_DITA RASCH DES backup xml 2 SCH_DES xml 2 SCH_DES_d xml 27 SCH_DES_design backup xmi 2 SCH_DES_design xml 2 SCH_DES_f backup xml 2 SCH_DES_f xmi 2 SCH_DES_f_connect xml 2 SCH_DES_f_dissipation xmi S SCH_DES_function xml 2 SCH_DES_g xmi 2 SCH_DES_g_anchoring xml 2 SCH_DES_g_connect xml 2 SCH_DES_g_vert coup sup xml 2 SCH_DES_r xml 2 SCH_DES_r_connect xml ke SCH_DES_r_design backup xml S SCH_DES_r_design xmi 2 SCH_DES_s xmi 2
74. he muff coupling consists of two muffs The lower muff is provided with a drain hole Connection Both muffs are tied up with four hexagon head screws and hexagon nuts and secured with lock washers Figure 3 6 Muff coupling principle drawing Version 1 04 04 Page 3 8 COMPONENTS DESCRIPTION AND FUNCTION 3 3 6 Earthing S The coupler half is equipped with earth wires in order to by pass non conductive components The earth strands consist of cables with a diameter of 50 mm The position of the earth wires is shown in figure Earth wires Figure 3 7 Earth wires EE oe Ue ij wl Hij L i 1 Hexagon head screw 15 Earth wire 5 Lock washer 17 Earth wire 7 Disk Version 1 04 04 Page 3 9 OPERATING INSTRUCTIONS 4 Operating instructions This chapter describes the coupling and uncoupling of semipermanent coupler halves ar NOTE The semipermanent coupler half 2 035 167 is designed for use with the coupler half 2 035 166 4 1 Connection of coupler halves Two cars equipped with semipermanent coupler halves are connected as follows 4 1 1 Tools and materials e torque wrench hammer piece of wood as shock protection or plastic hammer grease RIVOLTA GWF 2 hexagon head screws ISO 4014 M16x130 8 8 A3P 2 hexagon nuts ISO 4032 M16 8 A3P 2 lock washers VS16 lifting crane with a sufficient lifting capacity lifting straps trestle cleaner LOCTITE 7063 grease RIVOLTA GWF screw
75. heets erm glichen zwar die Produktion von verschiedenen Ausgabemedien wie Microsoft HTML Help Java Help und auch Web Seiten allerdings seien Mechanismen zur Wiederverwendung von Inhalten in unterschiedlichen Dokumenten und Medientypen nicht gegeben Allein schon das abspeichern von einzelnen Kapiteln in einzelne Dateien erfordert bei DocBook einen hohen Aufwand Hentrich 2008 S 79 20 Die Wiederverwendung von h ufig verwendeten Informationen f r unterschiedliche Zielgruppen setzt unter anderen eine gewisse Feingranularit t voraus Zudem haben unterschiedliche Medientypen tendenziell unterschiedliche Strukturen Auch die Formulierungen und Terminologie sind medienspezifisch Eine DTD der eine Buchstruktur zugrunde liegt kann diesen Anforderungen nicht gen gen 21 5 Strukturierungsmethoden Zur einheitlichen bzw standardisierten Dokumentationserstellung werden Strukturierungsmethoden eingesetzt die Einfluss auf logische und didaktische Strukturen sowie Satzbau und Stil nehmen Zus tzlich sind die Informationspro dukte in ihrer Gestaltung konsistent da eine durchg ngige Nutzung von Design Typographie Layout und Grafikeinsatz erreicht wird Um Informationen zu strukturieren sollten sie zuerst unter einem funktionalen Aspekt und inhaltlichen Aspekt systematisch methodisch und auf allen Ebenen der Textstruktur analysiert werden Selbst der Einsatz eines XML Standards entbindet nicht von einer sorgf ltigen
76. hipping damage Storage The coupler half should be stored indoors palletised and if possible protected from direct sunlight Prior to any storage it is imperative to remove all damage caused by corrosion and to renew the anticorrosive coating refer to the maintenance schedule section 3 2 and greasing plan section 3 3 For safety reasons the pluggable hose and the gasket of the air pipe connection should be replaced after longer storage periods exceeding 4 years before putting the coupler half into operation again Version 1 04 04 Page 5 3 B Nach dem DITA Konzept erstellte Teile des Benutzerhandbuchs GENERAL INFORMATION FOR THE USE OF THE MANUAL 1 General information for the use of the manual Drawings explaining a functional principle e g positions of the coupler lock lubrication charts may show components that are not identical with those of the described coupler Use of the terms Front Rear Right and Left Front means the side of the coupler where the coupling line is located Rear means the side of the coupler that is fixed to the car underframe e Right and Left refer to view in direction of traffic Special remarks A DANGER Warning of danger of life and risk of injury Non observance of this warning may result in grave consequences of health and lead to mortal injuries 2 CAUTION Important information for the correct use of the equipment Non observance for this information may res
77. ht im FM durch ffnen und Schlie en der DITA Dateien Weiterhin k nnen ber DITA Optionen die Handhabung der DITA Dateien beim Import Export festgelegt werden 55 DITA Optionen 33 Allgemeine Optionen DITA Topic Anwendung Chapter V Conrets beim ffnen von Datei automatisch laden DITA Map Anwendung Map E V Querverweise beim Offnen von Datei automatisch laden Prolog beim Olfnen von Datei konditionalisieren V Kommentare beim Offnen von Datei konditionalisieren DITA Book Anwendung FM Book X Standardtyp Neu xml v V IDs automatisch hinzuf gen falls Element dies erfordert Standard ID Pr fix SCH_ Zi V Neue Themen in DITA Element einschlie en Extemen Querverweisen Hypertext Marke hinzuf gen Importoptionen Exportoptionen V Konvertierung Indexeintrag in Indexmarkierung V Konvertierung Indexmarkierung in Indexeintrag V Spalten in Tabellen z hlen peichem Abtrechen Abbildung 14 Einstellung von DITA Optionen Die Einstellm glichkeiten sollen hier nicht weiter ausgef hrt werden F r die DITA Map Unterst tzung stellt FM f r die Erstellung und Bearbeitung von DITA Maps und auch f r die Verwaltung von Beziehungstabellen eine Strukturan wendung bereit Die einzelnen Strukturanwendungen werden im n chsten Abschnitt ausf hrlicher beschrieben Die Unterst tzung des conref Mechanismus f r die Referenzierung von Inhalten wird zus tzlich durch eine farbliche Kennzeichnung
78. ichen Kommunikation wird die Funktion einer u erung durch charakteristische Formulierungsmuster z B die Verwendung des Imperativs oder imperativen Infinitivs f r Handlungsaufforderungen und oder typografische Auszeichnungen z B Hervorhebungen Schriftart gekennzeichnet Entscheidend f r das richtige Verst ndnis ist dass die sprachlichen und gestalterischen Mittel konsistent verwendet werden vgl Sch flein Armbruster 2006 S 6 24 Nach der FD Technik weist jeder Text ein kommunikatives Handlungsziel mit einem bestimmten Formulierungsmuster auf Fiir die Technische Dokumentation bedeutet dies dass alle Teile eines Informationsproduktes bzw einer Dokumentart als Funktionale Elemente identifiziert werden k nnen vgl Hentrich 2008 S 83 Ein Funktionsdesign erfordert eine klare Definition aller Funktionalen Elemente nach einem einheitlichen standardisierten Beschreibungsmuster Die Standardisie rung kann auf vier Ebenen erfolgen z Warnhinweis Funktionale Einheiten z B Voraussetzung Resultat Auszeichnungselemente z B Produktnamen Men Abbildung 1 Ebenenmodell die vier Ebenen des Funktionsdesigns In den folgenden Abschnitten werden die einzelnen Ebenen des Funktionsdesigns n her beschrieben Informationsprodukte Nach der FD Technik wird jedes Informationsprodukt nach einer bestimmten Textsorte klassifiziert Textsorten lassen sich als typische Verbindungen von kontextuellen situativ
79. ie m glichen Gefahren im Umgang mit dem Produkt hinzuweisen Die Sicherheitshinweise enthalten in Anlehnung an der ANSI Norm Z535 und der ISO 3864 Piktogramm Signalwort Art Quelle der Gefahr Folgen und Ma nahmen Diese Struktur wird im Benutzer handbuch nicht konsequent befolgt und sollte angepasst werden 2 Support the coupler half with a lifting crane and straps and align it with the anchoring plate 2 CAUTION Parts can get loose Seat engaging surfaces for screws and nuts must be free from paint and grease in order to ensure correct tightening a NOTE For the installation of the coupler half also refer to the current installation requirements of the car builder 3 Install the coupler half according to the current installation requirements of the car builder Abbildung 23 Sicherheitshinweise vor einem Handlungsschritt 67 Ausgehend von den Betrachtungsebenen des Funktionsdesigns Abschnitt 5 2 Funktionsdesign bildet ein Sicherheitshinweis ein Sequenzmuster innerhalb eines Informationsprodukts z B Safety precautions das aus den Funktionalen Einheiten Piktogramm Signalwort Art Quelle der Gefahr Folgen und Ma nahmen besteht Handlungsanweisungen Die Handlungsanweisungen bef higen den Anwender eine Aufgabe vollst ndig auszuf hren und m ssen demzufolge in sich abgeschlossen sein Sie haben eine berschrift die die Art der Handlungsanweisung beschreibt und mehrere Ziel und Teilzielangaben
80. ing on it are supported by the rubber cushions and an additional supporting spring which is fixed under the drawgear by means of two hexa gon head screws This spring prevents the coupler when in uncoupled position from bouncing during operation and also allows to adjust the vertical position of the coupler Version 1 04 04 Page 3 6 COMPONENTS DESCRIPTION AND FUNCTION Figure 3 4 Characteristic of the rubber cushion drawgear D 095 Fwd 800 4 680 10 4 600 3 500 4 390 210 Li E Range of spring S mm Draft 40 55 Buff Spring resilience W 7075 W 14100 Absorptions rate W 65 W 65 Connection to coupler shank The free end of the rubber cushion drawgear is shaped as a flange onto which a muff coupling can be fitted to connect the drawgear to the coupler shank Anchoring to car underframe The bearing bracket is fastened with four screws to the anchoring plate on the car underframe Figure 3 5 Working mode of the cushioning unit Vey R A yy wii 8 a SE B ii yon A Sp N Version 1 04 04 Page3 7 COMPONENTS DESCRIPTION AND FUNCTION 1 Journal 4 Rubber cushion 7 Journal 2 Bearing bracket 5 Center piece 8 Stop on buff 3 Upper shell 6 Lower shell 9 Stop on draft 3 3 5 Muff coupling R An easily detachable muff coupling is used to connect the coupler shank to the mating coupler half and to the rubber cushion drawgear Design T
81. ionsdesign Methode werden bei der IMAP Methode die Bed rfnisse der Zielgruppe analysiert und das Informationsbed rfnis in einer bestimmten Nutzungssituation ber cksichtigt Daraus k nnen eine optimale Strukturierung der zur Verf gung gestellten Information und eine zielgruppenge rechte Darstellung abgeleitet werden vgl B hler 2008 S 143 Die IMAP Methode basiert auf vier Hauptbausteinen vgl B hler 2008 S 147 Sieben Prinzipien zur Informationsaufbereitung Informationsstrukturierung in die Informationseinheiten Map und Block Sieben Informationsarten mit Darstellungsempfehlungen Zielgruppenspezifische Analyse Diese Bausteine werden in den nachfolgenden Abschnitten kurz beschrieben Sieben Prinzipien IMAP legt sieben Prinzipien fest die den technischen Redakteur bei der Erstellung Dokumentationen unterst tzen sollen vgl B hler 2008 S 150f Gliederungsprinzip Gliederung der Informationen in kleine leicht zu verarbeitende Einheiten Betitelungsprinzip jede Informationseinheit hat einen Titel der den Inhalt und oder Zweck bezeichnet Relevanzprinzip Darbietung thematisch zusammengeh riger und zielgrup penspezifischer Informationen 29 Einheitlichkeitsprinzip Verwendung einheitlicher Formulierungen Termi nologie Darstellung und eines einheitlichen Layout fiir gleiche Sachverhalte Prinzip der Auswahl eines optimalen Informationstr gers entsprechend der Informationsart werden I
82. itshinweise Produktbeschreibung mit den Informationen zu Betrieb Wartung Mon tage Reparatur St rungsabhilfe und Produktteilen Dokumentationsbezogene Informationen enthalten informative und be schreibende Inhalte Herstellername und Produktname Art und Bezeichnung der Dokumentation Haftungsausschluss und Copyright Vermerk nderungsvermerk Beschreibung der Dokumentation rientierungshilfen enthalten informative Inhalte Inhaltsverzeichnis Abbildungsverzeichnis 66 Diese Aufteilung soll helfen das kommunikative Ziel Informationsabsicht und die typischen Abfolgen kommunikative Muster der einzelnen Informationselemente zu identifizieren aus denen sich das jeweilige Informationsprodukt aufbaut Daraus konnen die Strukturbausteine festgelegt werden Die Informationsprodukte wurden nach den Prinzipien des Funktionsdesigns zun chst auf einheitliche Bausteine Sequenzmuster und ihre Informationselemente Funktionale Einheiten untersucht die h ufig eingesetzt werden und eine hinreichende Strukturkonsistenz aufweisen Im Folgenden sollen die Ergebnisse anhand ausgew hlter Beispiele vorgestellt werden Sicherheitshinweise Allgemeinen Sicherheitshinweise werden dem Anwender in einem Kapitel Safety precautions zur Verf gung gestellt Die Sicherheitshinweise die eine bestimmte Handlung betreffen werden unmittelbar vor einer Handlung gestellt Sie haben eine warnende Funktion und dienen dazu den Anwender auf d
83. ldokument erfasst werden und mit Hilfe des conref Mechanismus die Modulvarianten erstellt werden Die Inhalte vermitteln dem Anwender welche Werkzeuge er f r die Ausf hrung einer oder mehrerer Handlungen ben tigt Daf r wird das generische Topic verwendet Ein Topic wird mit dem Befehl DITA gt Neue Datei gt Neu lt topic task gt angelegt Entsprechend der Auswahl wird das Wurzelelement beim ffnen der Datei automatisch eingef gt und das Dokument beginnt mit dem lt title gt Element dem 75 ein Titel vergeben wird Weitere Elemente werden tiber den Elementekatalog ausgewahlt und eingefiigt Im Elementekatalog werden die Elemente angezeigt die an der Stelle wo der Cursor im Dokument oder in der Strukturansicht steht g ltig sind Nach dem lt title gt Element k nnen Elemente f r zus tzliche Informationen und weitere Wurzelelemen te eingef gt werden F r die Erfassung der Inhalte wird das lt body gt Element eingef gt Die Werkzeuge und Materialien sollen in einer Liste mit Aufz hlungszeichen dargestellt werden Dazu wird das Blockelement lt ul gt unordered list verwendet Innerhalb des lt ul gt Elements ist das lt 1i gt Element list item g ltig FrameMaker f gt nach dem lt 1i gt Element standardm ig das Absatzelement lt p gt ein Mit der Idee die Inhalte beispielsweise auch in einer Tabelle ohne Aufz hlungszeichen abbilden zu k nnen wurden die Eintr ge innerhalb des lt p gt Elemen
84. ldung 29 Quelldokument Tools and materials 76 Abbildung 30 Einf gen von conrefs een neednn 77 Abbildung 31 Referenzierte Elemente aus dem Quelldokument nuneeeen 78 IV Abbildung 32 Abbildung mit einer Abbildungsbeschriftung 0 0 0 0 sesessessesessesseeseeseenes 79 Abbildung 33 Legende einer Abbildung aus ie eu 80 Abbildung 34 Handlungsanweisung mit Sicherheitshinweisen und einer Abbildung 81 Abbildung 35 Sicherheitshinweise im Quelldokument nunssenenenenensnennennnn 82 Abbildung 36 Sicherheitshinweise vor einem Handlungsschritt eeseeen 83 Abbildung 37 Erstellen einer DITA S Map aaa ana aa 84 Abbildung 38 Ansicht der Buchstr kt ur u aa 85 Abbildung 39 Dialogfenster f r das DITA Open Toolkit unesesesenenenennennenennennen 86 Abbildung 40 Aus DITA XML Dateien XHTML Dateien erzeugen nnesnesnnenn 87 Abbildung 41 Modulbildung und topic orientierte Strukturierung 89 Tabellenverzeichnis Tabelle 1 Informationsarten der IMAP Methode VI 1 Einleitung Die standardisierte Erstellung Technischer Dokumentationen und die abschlie ende Verwaltung bersetzung Publikation und Verteilung in einer heterogenen Umgebung ist gegenw rtig ein bedeutendes Rationalisierungspotential der Hersteller und Verwaltung F r die technische Dokumentation gelten zudem hohe Qualit ts ma st be Sie muss vollst ndig verst ndlich einfach nutzbar und zug nglich sein
85. lt wurde DITA von IBM International Business Machines Corporation zun chst f r die eigenen Dokumentationsanforderungen Das Ziel war der Einsatz eines flexibleren und einfacher zu handhabenden Dokumentationsstandards vgl Hentrich 2008 S 15 2004 wurde DITA als Open Source Architektur an OASIS Organization for the Advancement of Structured Information Standards bergeben und im Mai 2005 in der Version 1 0 als OASIS Standard verabschiedet Im Mai 2007 wurde DITA erweitert und liegt zum Zeitpunkt der Diplomarbeit in der Version 1 1 vor vgl Closs 2008 S 10 Eine Besonderheit dieses Standards ist der Mechanismus der Spezialisierung Auf Basis der in DITA vorgegebenen Grundtypen k nnen durch Spezialisierung neue Domains und Topic Typen entwickelt werden Nach dem Prinzip der Vererbung werden die f r die Ausgangstypen vorgenommenen Festlegungen an die abgeleiteten neuen Typen weitervererbt und k nnen bei Bedarf spezifisch angepasst oder erweitert werden vgl Closs 2005 Demnach ist DITA universell einsetzbar kann aber an unternehmensspezifische Anforderungen angepasst werden kann F r die XML basierte Informationsstrukturierung bietet DITA zahlreiche Elemente die allerdings gr tenteils nur f r Software Dokumentationen verwendet werden k nnen Erst mit der Version 1 1 sind Elemente ber cksichtigt die buchspezifische Merkmale abdecken vgl Hentrich 2008 S 14f Gegen ber der Version 1 0 werden zur verbesserten Unt
86. lth Hazardous vapours may be produced when using cleaning solvents Observe applicable safety regulations 2 CAUTION Surfaces can be damaged Do not use alkaline cleaners for galvanised and chromed surfaces Do not use diesel oil or motor gasoline containing benzol which prevent formation of a lubricating film and develop corrosion 5 1 1 Preparation e Clean parts with oil free compressed air brush or leather rag before greasing 5 1 2 Replacement of parts In most cases visual check for corrosion wear and damage is sufficient to decide whether or not a part should be replaced e After any removal and dismantling of a subassembly fastening elements such as screws nuts tab washers lock washers retaining rings spiral rings and spring type straight pins have to be replaced Sealing rings gaskets and rubber tubes have to be replaced at regular intervals but not later than after removal and dismantling of a subassembly e Wearing parts such as bearing bushes anti friction rings bolts or rubber parts should be replaced if worn out unless otherwise stated 5 1 3 Loosening of screwed connections Screws bolts threaded pins etc which are secured with acrylate glue must be heated cautiously before being loosened 5 2 Maintenance schedule The maintenance rates stated in the schedule are standard figures The time intervals must be reduced in case of adverse operating conditions particularly as cleaning and greasing
87. medien dient es als Navigationselement beispielsweise in der Navigationsliste einer Online Hilfe oder im Inhaltverzeichnis eines Handbuches Das lt title gt Element darf auch leer sein wenn der Inhalt des Topics keine berschrift haben soll z B Copyright Vermerk Nach dem lt title gt Element k nnen optional das lt body gt Element oder weitere Wurzelelemente der Topic Typen eingef gt werden Die Strukturelemente f r die Inhalte sind im lt body gt Element enthalten Die spezialisierten lt body gt Elemente sind lt taskbody gt lt conbody gt und lt refbody gt Welche Strukturelemente zur Verf gung stehen h ngt vom jeweiligen Topic Typ ab 37 6 1 2 Strukturelemente fur die Inhalte F r das generische Topic sind zahlreiche Elemente definiert die auch in den spezialisierten Topic Typen verwendet werden k nnen Das sind Elemente f r alternativer Navigationstitel und Titel f r Suchergebnisse lt titlealts gt Beschreibung der Inhalte in einer Link Vorschau lt abstract gt Blockelemente um Informationen innerhalb eines Topics zu strukturieren wie zum Beispiel lt p gt Absatz lt ul gt Liste mit Aufz hlungszeichen lt d1 gt Definitionsliste lt ol gt nummerierte Liste und lt table gt Tabelle Metadaten Grafiken lt image gt und Multimedia Objekte lt object gt Indexeintr ge lt indexterm gt Die spezifischen Strukturelemente der Topic Typen charakterisieren Ar
88. men tationen mit Adobe FrameMaker 8 zwar m glich ist aber aus wirtschaftlicher Sicht nicht optimal Eine automatisierte Verarbeitung von DITA XML Dateien f r die Druckausgabe sollte mit standardisierten XML Sprachen XSLT XSL FO aus Zeit Qualit ts und Kostengr nden favorisiert werden Im Anhang B wurden Teile aus der erstellten Dokumentation ohne Nachbearbeitung beigef gt 90 8 Zusammenfassung Aufgabe dieser Diplomarbeit war das DITA Informationsmodell auf seine Anwendbarkeit in der Technischen Dokumentation f r die Schienenfahrzeugtechnik zu berpr fen Die Bearbeitung der Beispieldokumentation hat gezeigt dass f r die Erfassung der Inhalte und Metadaten in Topics geeignete Strukturelemente und Attribute vorhanden sind F r eigene Strukturierungsanforderungen k nnen ber den Mechanismus der Spezialisierung neue Informationsstrukturen erzeugt werden Um die Inhalte wieder verwenden zu k nnen sind zwei M glichkeiten gegeben Topics werden in einer Map referenziert Inhalte werden mit dem conref Mechanismus in anderen Topics referenziert In einer geeigneten Redaktionsumgebung k nnen die Verarbeitung und Publikation in unterschiedliche Ausgabemedien weitgehend automatisiert werden Um alle Funktionalit ten nutzen zu k nnen sind allerdings aufw ndige Vorarbeiten Organisation Konzeption Anpassung Schulung usw eine geeignete Redaktions umgebung XML Editor CMS und spezifische Kenntnisse XML XSLT CS
89. mentekatalog Strukturansicht und Dokument auf einer Oberfl che In der Strukturansicht k nnen die Topic spezifischen Elemente ber die Platzierung des Cursors an einer g ltigen Stelle eingef gt werden 57 Zudem k nnen den Attributen der einzelnen Elementen Werte vergeben werden Alle Elemente die f r das jeweilige Topic oder f r eine Map zul ssig sind werden im Elementekatalog angezeigt Welche Elemente an welcher Stelle g ltig sind wird durch ein H kchen kenntlich gemacht Zudem besteht weiterhin die M glichkeit dem Redakteure f r die Erstellung beispielsweise eines Task Topics nur bestimmte ausgew hlte Elemente zur Verf gung zu stellen EET A E OE EE E O PE EAA A E EE EIEEE Ele mente xs v lt TEXT gt a 5 apiname vb Verf gbare Elemente zuweisen Tags einblenden f r v boolean vV cmdname G ltige nachgeordnete Elemente Standardreihenfolge codeph v filepath G ltige nachgeordnete Elemente beliebige Reihenfolge vi Alle zugelassenen nachgeordneten Elemente E komd menucascade Alle Elemente J msanum Spezielle Liste s mapi Einschl sse V patmname Nach anderen g ltigen Elementen auflisten k x Eingliedem Zuweisen Optionen Abbildung 17 Verf gbare Elemente f r eine Map zuweisen Damit wird die Verwendung falscher Elemente weitgehend verhindert und zudem das Suchen eines Elements eingegrenzt Abschlie end sei erw hnt dass zu den DITA Funktionen a
90. mplexit t wirkt allerdings abschreckend da die Spezifikation etwa ber 2500 Seiten umfasst Die Prinzipien von S1000D k nnen aber als Grundlage f r eigene Dokumentationskonzepte dienen vgl Ferlein 2005 S 63 16 4 3 mumasy Das Multimediale Maschineninformationssystem mumasy ist ein speziell f r den Maschinen und Anlagenbau entworfener Standard f r den Austausch und die Publikation von Informationen Das Konzept wurde im Rahmen des mumasy Projekts unter Koordination des Verbands Deutscher Maschinen und Anlagenbau e V VDMA und unter gezielter Einbeziehung von Dienstleistern Software Herstellern und produzierenden Unternehmen entwickelt Ziel war ein hersteller unabh ngiges Informationsmodell f r den Maschinenbau um den Datenfluss zwischen Herstellern Zulieferern und Kunden ber den gesamten Produktentwick lungszyklus zu verbessern vgl Ferlein 2005 S 62f Nach Ende des Verbundprojekts arbeitete der Arbeitskreis Technische Produktdo kumentation im VDMA weiter und verabschiedete 2006 das VDMA Einheitsblatt 66320 vgl Schmidt 2006 S 25 Der Einsatz des mumasy erm glicht ber den gesamten Produktlebenszyklus Informationen aller Art ber eine Maschine zu erfassen und diese zielgruppengerecht zur Verf gung zu stellen Das mumasy Informationsmodell verbindet vier Strukturen bzw Sichtweisen einer Maschine Aufbau Funktion Handlung Produkt und erm glicht eine umfassende Darstellung f r die Anwende
91. mte Benutzerhandbuch gelten Abbildungen Die Abbildungen haben sowohl eine beschreibende als auch eine textunterstiitzende Funktion und enthalten Positionsnummern mit denen Baugruppen bzw Bauteile identifiziert werden k nnen Zu den Abbildungen geh ren eine Legende und eine Abbildungsbeschriftung 1 Supporting spring 2 Hexagon head screw 3 Hexagon nut Fig 5 1 2 Vertical alignment of the coupler half principle drawing Abbildung 25 Abbildung und die Elemente der Abbildung An diesem Beispiel ist ebenfalls ein Sequenzmuster erkennbar das aus den Funktionalen Einheiten Abbildung Legende und Abbildungsbeschriftung besteht Die ermittelten Strukturmerkmale des Benutzerhandbuchs bilden die Grundlage fiir die Modularisierung der Informationen Um eine konsistente Vorgehensweise bei der Erfassung der Inhalte in Topics zu erreichen wurden Festlegungen definiert die im folgenden Abschnitt beschrieben werden 69 7 1 2 Modularisierung der Informationen Das Kriterium f r die Modulbildung nach dem DITA Standard ist die inhaltliche Abgeschlossenheit der im Modul enthaltenen Informationen Dadurch sollen die Informationen m glichst kontextunabh ngig wiederverwendet werden k nnen Die Abgeschlossenheit allein zu betrachten ist nicht immer ausreichend da sie bei Komponenten Dokumentationen in der Schienenfahrzeugtechnik gro e Module auf Kapitel und Unterkapitelebene erzeugt Diese sind selbst bei kleinen
92. n Dar ber hinaus k nnen ber Tabellen die Beziehungen der Topics untereinander dargestellt Metadaten vergeben und damit die Verarbeitung von Maps gesteuert werden 44 6 2 1 Aufbau der Map Eine Map enth lt Verweise zu den Topics Damit ist die Map eine Informationsstruk tur die das Wiederverwenden von Inhalten erm glicht lt xml version 1 0 encoding UTF 8 gt lt DOCTYPE map PUBLIC OASIS DTD DITA Map EN map dtd gt lt map id map id title Maptitel gt lt map gt Abbildung 10 Grundstruktur einer DITA Map Auch eine Map beginnt mit der XML Deklaration Darauf folgt die DOCTYPE Deklaration in der die map dtd Datei referenziert wird Die DTD wiederum verweist auf die Moduldatei map mod in der die Elemente die Map definiert sind Eine Map wird ber das Wurzelelement lt map gt erkannt Im Wurzelelement muss ein Wert f r das Attribut id zugewiesen werden wodurch die Map eindeutig identifiziert werden kann Anders als bei den Topics wird der Titel ber das title Attribut vergeben der beispielsweise in einer Online Hilfe im Fenstertitel oder bei einer PDF Datei auf dem Deckblatt angezeigt wird Das Wurzelelement beinhaltet folgende Elemente vgl Closs 2007 S 178 lt anchor gt Ankerstelle f r eine dynamische Map Erstellung lt navref gt Verweis auf eine Map f r eine dynamische Map Erstellung lt reltable gt Beziehungstabelle lt topicgroup gt Gruppe von Topicref
93. n Fakten in Form von Tabellen Listen Texten Klassifikation Welche Arten von Informationen gibt Maps und Bl cke es Tabelle 1 Informationsarten der IMAP Methode Quelle B hler 2008 S 154 31 Durch die Verwendung der Informationstypen und die Anwendung der sieben Prinzipien soll erreicht werden dass die Dokumente und die darin enthaltenen Texte klar gegliedert sind damit Informationen schnell aufgefunden und in einer verst ndlichen Form aufgenommen werden k nnen Bei der Erstellung der Dokumente soll eine h here Effizienz erreicht werden Zielgruppengerechte Analyse Bei der zielgruppengerechten Analyse nach der IMAP Methode werden die Inhalte bestimmt die f r eine Dokumentation relevant sind Diese sollen aus der Sicht des Anwenders alle notwendigen aber keine berfl ssigen Informationen enthalten Anhand der ermittelten m glichen Fragen des Anwenders werden Inhalte eines Dokuments oder einer Information abgeleitet Eine logisch sachliche Anordnung der einzelnen Informationsmodule zu gr eren zusammenh ngenden Themen ergibt dann eine aus der Anwendersicht generierte Dokumentstruktur vgl B hler 2008 S 156f 32 6 Darwin Information Typing Architecture DITA DITA ist eine XML basierte Informationsarchitektur fiir die Erstellung Verteilung und Wiederverwendung von Informationen die speziell fiir die Technische Dokumentation entwickelt wurde vgl Hentrich 2008 S 14 Entwicke
94. n Stellen Dies hat zur Folge dass die Dokumentation in modifizierter Form vorliegt und die Nachbearbeitung bei Anderungen wiederholt werden muss Um eine automatisierte Verarbeitung zu erreichen sind aufwandige Anpassungen des XSL Stylesheets und genaue Kenntnisse ber die Verarbeitungs prozesse notwendig Zur Anwendung von Adobe FrameMaker 8 f r die Erstellung und Bearbeitung von DITA XML Dateien sei abschlie end festzuhalten dass in der Standardausf hrung die DITA Funktionen zum gro en Teil unterst tzt werden F r die Verwendung des xref Mechanismus f r die Bearbeitung von Querverweisen muss zus tzlich das kostenpflichtige DITA FMx Plug in von Leximation Inc installiert sein Die Anwendung wird durch die FrameMaker Oberfl che erleichtert Wie bei jedem anderen XML Editor auch m ssen f r unternehmensspezifische Anforderungen an die Gestaltung vorerst Anpassungen vorgenommen werden Im FrameMaker geschieht dies durch die Anpassung der mitgelieferten EDDs und Templates der DITA Anwendungen Spezialisierte DTDs bookmap glossentry k nnen im FrameMaker nicht sofort angewendet werden Da FrameMaker bei strukturierten Dokumenten nicht auf die zugrundeliegenden DTDs zur ckgreift sondern auf eine eigene Strukturdefinition EDD k nnen erst nach der Entwicklung der entsprechenden EDD spezialisierte Informationsstrukturen erstellt und bearbeitet werden Insgesamt kann gesagt werden dass die Produktion DITA strukturierter Doku
95. n again 7 3 Vertical alignment The coupler half tends to subside during use As this increases the load on the rubber cushions in the drawgear the horizontal position has to be readjusted The correct alignment of the coup ler half has to be checked at regular intervals cr NOTE During its first year of operation a new supporting spring suffers setting of the rubber After installing a new supporting spring the vertical alignment of the coupler half must be checked on a monthly base The horizontal position can be adjusted by means of two hexagon head screws which also fix the supporting spring to the bearing bracket 7 3 1 Tools and materials standard tools e spirit level 7 3 2 Preparation None 7 3 3 Vertical alignment gt CAUTION Correct alignment is only possible with completely assembled coupler half Loosen four hexagon nuts 3 2 Uniformly turn both hexagon head screws 2 clockwise to raise the coupler half and counter clockwise to lower it 3 Use a spirit level to check the vertical alignment of the coupler half Retighten four hexagon nuts 3 The recommended tightening torque is 350410 Nm Version 1 04 04 Page 7 21 MOUNTING AND REPAIR INSTRUCTIONS 7 3 4 Figure 7 2 Vertical alignment of the coupler half principle drawing AIR ARAE AR 1 Supporting spring 3 Hexagon nut 2 Hexagon head screw Version 1 04 04 Page 7 22
96. n des Produkts werden ber cksichtigt Einheitliches Erscheinungsbild der inhaltlichen strukturellen und formalen Gestaltung Konsistenter Aufbau und Gestaltung f r eine leichtere Handhabung Konsistente Verwendung von Textstrukturierungsmitteln Layout Typo grafie Bildern Piktogramme Terminologie und Abk rzungen Die Anwender lassen sich anhand ihrer Qualifikation und Erfahrung in Zielgruppen unterteilen W hrend die Qualifikation berwiegend Einfluss auf ihre Aufgaben und voraussichtlichen Probleme am Produkt und damit auf die technischen Inhalte der Dokumentation nimmt stellt die Erfahrung Anforderungen an den Detaillierungs grad der Inhalte Demzufolge sollten Dokumentationen inhaltlich sprachlich und in der u eren Handhabung m glichst genau auf die Zielgruppe abgestimmt werden vgl Hoffmann und H lscher 1994 S 23 Dar berhinaus sind auch Unterschiede hinsichtlich der Informationsanordnung und gruppierung von der Kenntnis ber die Zielgruppe abh ngig So ist beispielsweise f r den Anwender eines Produkts eine handlungsorientierte Strukturierung notwendig wohingegen Techniker eher konkrete Informationen ber die Produkteigenschaften und bestandteile ben tigen d h eine produktorientierte Strukturierung hilfreich vgl Romberg 2000 S 21 2 3 Unterst tzung der Dokumentationsprozesse Aus den Anforderungen an die inhaltliche Qualit t k nnen Vorgaben f r die Erstellung Technischer Dokumentationen de
97. nal zur Verf gung gestellt lt ATTLIST note type note tip fastpath restriction important remember attention caution danger other IMPLIED gt Abbildung 4 Definierte Werte des type Attributs 40 Laut Unterarbeitskreis Maschinenbau sind folgende Anderungen erforderlich die Attribute des lt note gt Elements werden mit caution1 caution2 warning and notice erg nzt hazard statement Domain nach dem ANSI ISO Standard f r Sicherheitshin weise Der Arbeitskreis liefert daf r einen Entwurf f r ein lt hazardstatement gt Element lt ELEMENT hazardstatement messagepanel symbol gt lt ATTLIST hazardstatement type note tip fastpath restriction important remember attention notice caution cautioni caution2 warning danger other IMPLIED gt lt ELEMENT messagepanel typeofhazard consequence Showtoavoid gt Abbildung 5 Vorschlag f r die Domain hazard statement in DITA 1 2 Ein Sicherheitshinweis k nnte dementsprechend wie folgt erfasst werden lt hazardstatement type caution gt lt messageplanel gt lt typeofhazard gt Risk of damage to air pipes lt typeofhazard gt lt consequence gt when two semipermanent coupler halves are connected with muff coupling in horizontal position air pipes might be damaged lt consequence gt lt howtoavoid gt Install muff coupling vertically lt howtoavoid gt lt messageplanel g
98. nd beispielsweise vgl Hentrich 2008 S 294 Eclipse Syntext Serna XMetal Author Enterprise Edition XMLmind XML Editor lt oXygen gt XML Author Adobe FrameMaker seit Version 7 2 Die XML Editoren sollen in dieser Arbeit im Einzelnen nicht weiter beschrieben werden Im Folgenden sollen Anforderungen bzw Eigenschaften definiert werden die ein XML Editor als Erstellungswerkzeug fiir DITA erf llen sollen Zu den wichtigen Eigenschaften geh ren Validierung eines DITA XML Dokument gegen ber einer DITA DTD berpr ft ob das Dokument wohlgeformt ist Es werden nur g ltige Elemente und Attribute angeboten Unterst tzt den conref Mechanismus Erkennt spezialisierte Informationsmodelle Integration des DITA Open Toolkits 52 Aus der Autorensicht sollen die XML Editoren leicht benutzerfiihrend bedienbar sein Ob eine what you see is what you get Ansicht bzw Oberfl che als Auswahlkriterium betrachtet werden kann ist umstritten Das Ziel einer XML basierten Dokumentationserstellung ist eine klare Trennung von Inhalt und Layout Allerdings mit dem Hintergrund Informationen fiir unterschiedliche Zielgruppen Dokumente und Medien bereitzustellen Argumentiert wird aber h ufig dass Redakteure sich auf die Inhalte konzentrieren k nnen und nicht mit Formatierungs aufgaben abgelenkt werden Ein XML Editor sollte dennoch ber Funktionen wie mindestens ber eine Druckvorschau verf gen um dem
99. nect_final xml 2 SCH_OI_connect preparation xml 2 SCH_OI_connect_steps xml 2 SCH_OI_connect_tool xml 2 SCH_OI_separat xml ey SCH_OI_separat_preparation xml 2 SCH_OI_separat_steps xml 2 SCH_OI_separat_tool xml 72 Im Hinblick auf die Wiederverwendung der Inhalte au erhalb des Unternehmens bereichs wurde der eigentlichen Dateibezeichnung das K rzel des Herstellers SCH vorangestellt Beispielsweise werden die Inhalte der St rungsabhilfe Trouble shooting im Instandhaltungshandbuch des Schienenfahrzeugs bernommen Die Dateien k nnen dann anhand des Herstellerk rzels einer Komponente zugeordnet und gezielt bearbeitet werden An dieser Stelle sei angemerkt dass aufgrund der hohen Menge an zu verwaltenden Dateien eine solche Umsetzung nicht ausreicht Die Verwaltung kann sollte durch ein externes System z B Content Management System unterst tzt werden 7 2 Vorbereitung Wie die Dokumente projektspezifisch verwaltet werden k nnen kann unter verschiedenen Aspekten festgelegt werden F r das Projekt wurde ein eigenes Verzeichnis unter den Namen Projects angelegt und in weitere Unterverzeichnisse aufgeteilt 4 gt Projects applications O contents_DITA Oo contents_FM O graphics s D out O chm O html O pof Abbildung 28 Projektverzeichnis Das Unterverzeichnis applications enth lt die Anwendungsdateien EDD Template und read writes rules der DITA Anwendungen Diese Anwendungsdateien wurden
100. nes CMS sollte demnach in Betracht gezogen werden Bei der Auswahl sollten vorerst die Anforderungen von DITA und auch die eigenen Anforderungen an ein CMS definiert werden Nach Hentrich 2008 stellt DITA folgende Anforderungen Verwaltung zahlreicher und feingranularer DITA XML Dateien Suchmechanismen f r die gezielte und bersichtliche Wiederverwendung und Verwendungskontrolle von Modulen und Medien Linkverwaltung Unterst tzung von Referenzierungen und Querverweisen Anpassungsmechanismen zur Spezialisierungen von unternehmensspezifi schen Informationsmodellen M glichkeit zur Integration des DITA Open Toolkits Versions und Variantenmanagement Sprachmanagement Kontrolle des bersetzungsprozesses und der Sprachva rianten Weitere positive Nebeneffekte die sich daraus ergeben sind beispielsweise Definieren von Benutzergruppen mit unterschiedlichen Aufgaben Steuerung von Zugriffsrechten Steuerung der Dokumentationsprozesse nderungsverwaltung bzw verfolgung Zentrale Datenhaltung und Produktion der Ausgabemedien Die Auswahlkriterien sollten zudem auch den Zeit und Kostenaufwand bzw die Vorgehensweise bei der Einf hrung ber cksichtigen 54 6 6 DITA Integration in Adobe FrameMaker 8 Die DITA Integration in FrameMaker FM gibt es bereits seit der Version 7 2 als frei verf gbares Plug in und ist seit der Version 8 im Standardumfang enthalten Mit der Integration werden die Funktionen der DITA Ver
101. nformationstr ger Texte Bilder Diagramme usw gew hlt Prinzip der Verf gbarkeit von Einzelheiten Einzelheiten der Zielgruppe entsprechend zur Verf gung stellen Prinzip der systematischen Gliederung und Betitelung Gliederung und Betitelung von Einheiten systematisch auf allen Ebenen anwenden Durch die Einhaltung der Prinzipien soll sichergestellt sein dass die Informationen zielgruppengerecht aufbereitet und bei umfangreichen Dokumentationen eine durchg ngige Konsistenz gew hrleistet wird vgl B hler 2008 S 151 Informationseinheiten Map und Block Ein wichtiger Grundsatz der IMAP Methode ist die Erstellung modularer Informationen Dazu werden die Inhalte in Maps gegliedert die wiederum aus einzelnen Bl cken bestehen Maps und Bl cke stellen demzufolge die Strukturie rungselemente dar vgl B hler 2008 S 151f Der Block ist die kleinste Informationseinheit eines Dokuments und wird ber einen Blocktitel eingeleitet Er enth lt nur eine in sich abgeschlossene Information wie ein Thema Bild usw Eine Map behandelt ein Thema und besteht meist aus mehreren Bl cken IMAP empfiehlt maximal f nf bis neun Bl cke zu verwenden auf maximal drei Seiten Das Thema wird ber einen Map Titel eingeleitet der die Schl sselin formation enth lt vgl B hler 2008 S 152 Durch die Aufbereitung der Inhalte in separaten Bl cken bzw Maps werden Informationen thematisch getrennt wodurch zum einen eine modulare St
102. ngen An dieser Stelle sei bereits angemerkt dass dies eine projektbezogene Sichtweise und sehr vereinfachte Darstellung ist die aber zum gro en Teil auf die Dokumentations abteilungen der Fahrzeug und Komponentenhersteller und auch der Dienstleister f r Technische Dokumentationen in der Schienenfahrzeugtechnik zutrifft Im Anschluss werden die Anforderungen an die Qualit t und an die Erstellung von Technischen Dokumentationen definiert 2 1 Ausgangslage Stand der Dinge Die Komplexit t von Schienenfahrzeugen bez glich ihrer Funktion und ihres Aufbaus und die hohen Sicherheitsanforderungen an das gesamte Fahrzeug und auch an die einzelnen Fahrzeugkomponenten zeichnen sich im Umfang der Technischen Dokumentation ab Die Dokumentationsbestandteile deren Inhalte und die Qualit tsma st be werden vom Fahrzeughersteller festgelegt Die Hauptbestandteile k nnen die Fahrzeugbeschreibung FB das Bedienhandbuch BH und das Instandhaltungshandbuch IHB sein Sie werden in der Regel von mehreren Redakteuren anhand der Herstellerinformationen und der Zuliefererdo kumentationen der Komponentenhersteller nach festgelegten Vorgaben Inhalt Terminologie Struktur usw erstellt Der Erstellungsprozess der Technischen Dokumentation ist am Produktionszyklus orientiert Dies bedeutet f r den Dokumentationsersteller gro e Informationsmengen erstellen und verwalten und bis zum Abschluss der Fahrzeugproduktion fertigzustellen Technische
103. nhaltlichen Aspekten bestimmt ist Sequenzmuster bilden ein kommunikatives Muster weil sie aus einer typischen Abfolge Funktionaler Einheiten aufgebaut sind Es wird beispielsweise definiert wo Warnhinweise oder Ergebnisse eines Handlungsschrittes platziert werden miissen Die innere Struktur und der inhaltliche und didaktische Aufbau sind auf die Zielgruppe und auch auf das Unternehmen zugeschnitten vgl Muthig und Schaflein Armbruster 2008 S 50 Liegen Sequenzmuster z B Sicherheitshinweise Handlungssequenzen Wartungs plane vor so k nnen die Funktionalen Elemente einheitlich standardisiert verwendet werden 26 Funktionale Einheiten Funktionale Einheiten sind die Basiseinheit fiir die Standardisierung Sie entsprechen quasi dem Sprechakt der Sprechakttheorie Werden Texte nicht nach dem Funktionsdesign Standard verfasst werden dennoch sprachliche Handlungen im sprechakttheoretischen Sinne vollzogen Dokumentierte Festlegungen Redaktions leitfaden f r diese Texte schaffen dabei die Voraussetzung f r qualitative und konsistente Textproduktion vgl Muthig und Sch flein Armbruster 2008 S 52 Bei der Entwicklung eines FD wird festgelegt welche Funktionalen Einheiten f r die Erstellung einer bestimmten Textsorte zur Verf gung stehen F r jede Funktionalen Einheit wird au erdem vorgegeben welchem Formulierungsmuster z B Satzbau sie folgt wie sie gestaltet wird welche Vorg nger und Nachfolgereinheiten zul
104. onen Beschreibungen bergreifender Konventionen Begriffserklarungen usw Die Aufbereitung der Informationen erfolgt aufgabenbezogen und teilweise in verschiedenen Organisationseinheiten was dazu f hren kann dass gleiche Sachverhalte von verschiedenen Redakteuren unterschied lich und mehrfach vorgenommen werden nderungen w hrend Entwicklung m ssen demnach an mehreren Stellen eingearbeitet werden und Korrekturen mehrfach durchgef hrt werden Die Erstellung Pflege und Publikation geschieht weitgehend manuell und Redakteure und auch bersetzer verbringen wertvolle Zeit mit Formatierungsar beiten Wird die Wiederverwendung vorhandener Informationen gefordert werden identische Inhalte meist aus schon vorhandenen Quellen kopiert dabei eventuell modifiziert und liegen somit in verschiedenen Varianten vor Keiner kann auf Anhieb sagen welche Textvariante aktuell und richtig ist Werden zudem die Dokumente auf Servern im Dateisystem abgelegt wird auf unterschiedlich Art versucht Zusatzinformationen zu den Dokumenten zu verwalten Der Aufwand potenziert sich mit jeder Produktvariante Solche Arbeitsweisen k nnen zeitaufw ndig fehleranf llig sein und zu weiteren Kosten f hren 2 2 Anforderungen an die Qualit t der Dokumentationen ber die Qualit t einer Dokumentation entscheiden die Endanwender Sorgf ltig strukturierte Informationen k nnen diese wesentlich verbessern und gleichzeitig Voraussetzungen f r eine konomi
105. ontally approx 25 Vertically approx 6 3 2 Function Scharfenberg semipermanent coupler halves are designed to ensure a permanent connection of railway vehicles which during normal operation form a unit and therefore need not be se parated unless in case of emergency or when conducting maintenance activities in the work shop The coupler halves are connected by means of easily detachable muff couplings that ensure a rigid slack free and safe connection The coupler halves permit coupled trains to ne gotiate vertical and horizontal curves and also allow rotational movements The connection and separation of the coupler halves is to be done manually The connection of the air pipe is automatically accomplished as the couplers halves are cou pled together A rubber cushion drawgear provides regenerative energy absorption and damping charac ter istics that are sufficient during normal coupling and operation conditions Loads exceeding the capacity of the rubber cushion drawgear are taken up by plastic deforma tion of a collapsible tube which is part of the coupler shank Version 1 04 04 Page 3 3 COMPONENTS DESCRIPTION AND FUNCTION The semipermanent coupler half 2 035 167 is designed for use with the semipermanent coup ler half 2 035 166 3 3 Design and subassemblies The semipermanent SCHARFENBERG coupler half consists of the following subassemblies ar NOTE The letters in brackets indicate the corresponding
106. ook 2 1 Prozent IMAP 2 1 Prozent S1000D 3 4 Prozent und DITA 4 1 Prozent 12 Kr ger 2007 stellt die Frage Warum sollten Anwender umsteigen wenn Strukturierung und System die gestellt Aufgaben erf llen Kr ger 2007 S 29 Die Unternehmen w rden von einer f r ihre Anforderungen ma geschneiderten An wendung zu einer Standardanwendung bergehen die zun chst sehr viel schwieriger zu handhaben ist auch weil in Standardstrukturen h ufig politische und nicht nur technische anwendungsbezogene Aspekte einflie en Kr ger 2007 S 29 Ein Vorteil der sich aus einem gemeinsamen und harmonisierten Dokumentations standard ergibt ist dass verschiedene Systeme Techniken und Organisationen die den gemeinsamen Standard einhalten zusammenarbeiten k nnen Informationen k nnen auf effiziente und verwertbare Art und Weise ausgetauscht bzw dem Anwender zur Verf gung gestellt werden ohne dass dazu gesonderte Absprachen zwischen den Systemen notwendig sind In einer gemeinsamen Ver ffentlichung von Kr ger und Ziegler 2008 werden Argumente betrachtet die einen Einsatz von XML gest tzten Standardstrukturen in der Technischen Dokumentation begr nden Als ein gro er Nutzen von Standardstrukturen wird hier ebenfalls die Austauschbarkeit und Verarbeitbarkeit genannt vgl Kr ger und Ziegler 2008 S 14 So erm glichen Standardstrukturen einen formatfreien und plattformunabh ngi
107. opics zu erstellen sind ist nur im geringen Ma e gegeben Um die Dokumentationserstellung konsistent durchf hren zu k nnen m ssen vorerst Regeln definiert und in einem Redaktionshandbuch dokumentiert werden Bezogen auf die Gliederungskriterien sollten mindestens folgende Fragen geregelt werden Wie wird die Dokumentation modularisiert Welche Informationen werden welchen Topic Typen zugeordnet Wie werden Topic Grenzen festgelegt Welche Elemente werden ben tigt und in einem Topic verwendet Welches Element wird f r welchen Typ von Information verwendet Welche Attribute werden eingesetzt Wie werden die Module zu einem Handbuch kombiniert Zudem muss berpr ft werden ob die Regelungen allgemein anwendbar sind oder f r unterschiedliche Dokumentationsarten spezifisch definiert werden m ssen Als Beispiel sei hier die Modulbildung genannt In der Schienenfahrzeugtechnik und auch in anderen Bereichen komplexer Produkte ist dies ein sehr umfangreiches Unterfangen da vielf ltige und komplexe Prozeduren im Zusammenhang des Betriebs zu dokumentieren sind Bedienung Wartung Reparatur St rungsfall Management Fehlerisolierung Ersatzteil Management usw 88 Das Definieren solcher Regelungen ist allerdings bei der Einf hrung XML basierter Anwendungen grunds tzlich notwendig Durch die linear aufgebauten Dokumentationen mit klassischer Kapitelstruktur entstehen Module die lediglich nur eine berschrift
108. ortance Choice Optional body Choices obsolete deprecated optional default low normal high recommended required urgent sean 8 Name rev String Optional example 9 Name status Choice Optional related rks Choices new changed deleted unchanged 10 Name outputclass String Optional ll Name xml lang String Optional vencen olomon 12 Name xmins ditaarch String Optional Reference elements Default http dita oasis open org architecture 2005 Control flags Read only Task elements Body elements 13 Name ditaarch DITAArchVersion String Optional Default 1 0 Table elements Control flags Read only Typogtaphio highlight elements 14 Name domains String Optional Programming elements Default topic ui d topic hi d topic pr d topic sw d topic ut d Bodini aiina 15 Name xtre String Optional 16 Name xtrf String Optional User interface elements E extfluss A E Choices 3 von 157 100 z ZAD Dok chapter eddfn 80 z lt Abbildung 20 Ansicht der EDD fiir die DITA Topic FM Anwendung Insgesamt beschreibt die Elementdefinition zul ssige Inhalte f r jeden Elementtyp wie Elemente formatiert werden und ob sie Attribute f r die Speicherung zus tzlicher Informationen besitzen Zus tzlich sind auch Informationen bez glich der Formatierung der einzelnen Elemente enthalten 63 Template In den strukturierten Templates Schablonen sind s mtliche Formatierungsvorga ben f r Te
109. pe Definition Desktop Publishing Element Document Definition Hypertext Markup Language identifier Information Mapping International Organization for Standardization Multimediales Maschineninformationssystem Organization for the Advancement of Structured Information Standards Portable Document Format Standard Generalized Markup Language Rich Text Format World Wide Web Consortium Extensible Markup Language Extensible Stylesheet Language Extensible Stylesheet Language Formatting Objects Extensible Stylesheet Language Transformations IH Abbildungsverzeichnis Abbildung 1 Ebenenmodell die vier Ebenen des Funktionsdesigns neneeneenen 25 Abbildung 2 Die vorgegebenen Topic Typen von DITA unnesesenenenensensenennennnn 35 Abbildung 3 Grundstruktur des generischen Topics ussnesenenenennennenenensenennennnnn 36 Abbildung 4 Definierte Werte des ype Att buts neuen a 40 Abbildung 5 Vorschlag f r die Domain hazard statement in DITA 1 2 41 Abbildung 6 Sicherheitshinweis mit dem lt hazard statement gt Element eneene 41 Abbildung 7 Task Topic innerhalb eines Concept Topics unsesenenenennenenennennen 42 Abbildung 8 Topic aus einer externen DITA XML Datei referenzieren eee 43 Abbildung 9 Flement eines Topics referenzieren an ai ic 44 Abbildung 10 Grundstruktur einer DITA Map usnsnssensensenensensenensensonensensnsensensnnensannne 45 Abbildung 11 Topic in einer
110. r vgl Hentrich 2008 S 88 Aufbaustruktur repr sentiert die Informationen zu Bauteilen der Maschine Funktionsstruktur repr sentiert die funktionale Produktstruktur einer Maschine Handlungsstruktur repr sentiert Handlungen und Ma nahmen im Umgang mit einer Maschine Dokumentstruktur repr sentiert Inhalt und Zusammensetzung der techni schen Dokumentation 17 Zur Informationsvermittlung ist eine Technische Dokumentation Dokumentstruk tur erforderlich ist welche den Aufbau Aufbaustruktur beschreibt die Funktionen Funktionsstruktur erkl rt und zu Ma nahmen und Handlungen Handlungsstruk tur auffordert Hentrich 2008 S 88 Auch dieser Standard wird von wenigen Firmen in der Praxis angewendet vgl Fritz 2008 S 1 2 In einer Befragung 2006 wurden folgende Gr nde genannt vgl Schmidt 2006 S 24f Zeitaufw ndige Einarbeitung in das mumasy Konzept Einsatz erfordert h heren Initialaufwand als andere Systeme Komplexit t der Struktur unzureichend dokumentiert fehlende Standard Templates f r Publikationen entspricht nicht den globalen Anforderungen deutschsprachige Elemente Hentrich 2008 f hrt auf dass das Informationsmodell zun chst eine systematische Grundlage darstellt auf der weitere Informationsprozesse entwickelt werden m ssen wodurch beim Einsatz von mumasy firmenspezifische Anpassungen notwendig sind Er f hrt ebenfalls auf dass f r die Verarbeitung von XML D
111. r DITA Generate Output die Option Selected Target ausgew hlt werden vgl Installationsanleitung Adobe FrameMaker 8 Plug in 2007 S 3 7 4 Auswertung DITA bietet vordefinierte Strukturen mit zahlreichen semantischen Strukturelemen ten die berwiegend die Strukturierungsanforderungen von Software Dokumentationen erf llen Spezifische Strukturierungsanforderungen anderer Anwendungsfelder k nnen mit dem DITA Spezialisierungskonzept umgesetzt werden Dass dies in einem nicht mehr berschaubaren Ma e erfolgen kann zeigen die einfachen Strukturregeln aus dem Beispielkapitel Anhang A f r diese bereits eine Spezialisierung der Informationsstruktur erfolgen m sste Um einige Beispiele zu nennen 87 Dem Redakteur sollte es erm glicht werden einen Warnhinweis direkt vor einen Handlungsschritt zu stellen und das ohne Umweg ber das Sub Element lt stepxmp gt das innerhalb des lt step gt Elements nach einem Handlungsschritt f r beispielhafte Erl uterungen folgen kann Es sollte auch m glich sein Abbildungsbe schriftungen unterhalb von Abbildungen platzieren zu k nnen Aparterweise sind solche Strukturregeln auch in der Software Dokumentation g ltig F r die Erfassung der Inhalte stehen dem Redakteur seit der DITA Version 1 1 f nf Topic Typen topic task concept reference glossentry zur Verf gung die beliebig verschachtelt und zu einem Gesamtdokument zusammengefasst werden k nnen Nach welchen Kriterien die T
112. r als 300 Elemente von DocBook sei an dieser Stelle auf ihre Referenzdokumentation verwiesen Die hohe Anzahl der Elemente resultiert unter anderem daraus dass bei der Entwicklung von DocBook verschiedene Interessen ber cksichtigt wurden Jede beteiligte Organisation hatte andere Erwartungen an die Funktionen und andere Vorstellungen von der Struktur einer Publikation sodass keine Einigung erzielt werden konnte zum Beispiel welche Elemente f r bestimmte Auszeichnungen definiert werden sollten Demzufolge wurden mehrere Varianten erm glicht Als Ergebnis kann jede Organisation die Struktur ihrer Publikationen beibehalten und muss nicht aufgrund strenger Vorgaben ihre Prozesse ndern was allerdings dazu f hrt dass es mehrere M glichkeiten zum Auszeichnen des gleichen Konzepts gibt vgl Cyganiak 2003 S 14 Eine Besonderheit von DocBook ist die flexible Erweiterbarkeit und Anpassungsf higkeit der DTD Sie ist so strukturiert dass neue Elemente eingef gt oder nicht ben tigte entfernt werden k nnen Soll eine DTD angepasst werden muss eine neue DTD angelegt werden das so genannte Driver File In dieser DTD k nnen neue Elemente definiert und Parameter Entit ten der DocBook DTD berschrieben werden Zuletzt wird die originale DocBook DTD in die Driver File importiert vgl Cyganiak 2003 S 19 DocBook wurde daf r entwickelt um Handb cher f r die Technische Dokumentati on zu erstellen Die zu DocBook entwickelten Styles
113. rchgesetzt die 1998 vom World Wide Web Consortium W3C als Standard empfohlen wurde XML is a technology not a methodology Fraley 2003 in Kollmann und H sel 2007 S 82 XML stellt also nur den L sungsansatz f r das SSP dar der aufgrund der Verbreitung von XML Technologien jedoch sinnvoll ist 10 In XML Dokumenten werden die hierarchische Struktur und der Inhalt der Dokumente festgelegt aber keine Angaben zum Layout gemacht Die Layout Angaben fiir das jeweilige Medium werden mit Hilfe sogenannter Stylesheets vervollstandigt um ein beliebiges Ausgabeformat zu erzeugen Um strukturierte XML Dokumente mittels eines Stylesheets in das jeweilige Zielformat zu berf hren bedarf es zus tzlicher Werkzeuge bzw Technologien Auch diese basieren zu einem gro en Teil auf XML So ist beispielweise die extensible Stylesheet Language XSL eine Familie von XML basierter Sprachen zur Erzeugung von Layouts f r XML Dokumente Teilsprachen dieser Familie sind XSLT XSL Transformations f r die Transformati on und XSL FO XSL Formatting Objects f r die Beschreibung eines XML Dokuments In der Summe erm glicht die XSL Familie die Bedienung von Bildschirm und Printversion indem sie Transformations und Formatierungsregeln definiert XPath XML Path Language ist eine Hilfssprache die von XSLT f r die Adressierung und den Zugriff auf Strukturbestandteile eines XML Dokuments verwendet wird Weiterhin bietet XPath die M glichkeit
114. rierungsmethoden nennen 22 SL Texte und Texistrukturen u nensi mannna a Ense 22 52 Bunktionsdesien 2 22 23 5 3 Information Mapping sand ende 29 6 Darwin Information Typing Architecture DITA useseesersessssorsesnnsonsnsnnnnene 33 6 1 Topics eu RA E e AE A EE NEEESE N E S 34 6 1 1 Aufbau der Topics inneren tin ns 36 6 1 2 Strukturelemente f r die Inhalte usessssesesssensenssensensnnensensnensenen 38 6 1 3 Domains zur Auszeichnung von Inhalten unneeensneneeneenseneeneensensennensennensennenn 39 6 1 4 Kombination der Topics nesseesennensensnnensensnnennensnnensenenntnsennnntnnennnnensennnntnnennnn 42 6 2 Map vases East rar Eee En abe He ie lanen 44 6 2 1 Aufbauder Map keins ATAA 45 6 2 2 Bookimaps sicsiiiiinilanadidaliaugidtuvaianaitiea tanta derek lan aaa a aeaa saai 46 6 3 Metadaten npin a dines etn liana ema mais 47 6 3 1 Metadaten f r die Verwaltung uneenesmsnseenensemnsenssensenneensennsenneensennenneennnenne 47 6 3 2 Metadaten f r die Verarbeitung uaessessnensnsensennensennennenennennsnnnensennensensensennensen 49 64 Werkzeuge ir DIT Au een 50 6 451 XMILAEdit ren u E A A OAE E A E EEE E EA 52 6 4 2 Entscheidung f r Adobe FrameMaker 8 nnnsneneensensenneensennennsenneennennsennenneen 53 6 5 Content Management Systeme CMS u a ihnen heine 54 6 6 DITA Integration in Adobe FrameMaker 8 un 55 66l DILA Fu nktion ne sina anni aeie aaa ia i
115. rukturie rung erreicht wird und zum anderen dem Anwender der Zugriff auf die Informationen in einer bestimmten Situation erleichtert wird vgl B hler 2008 S 153 30 Sieben Informationsarten Die thematische Trennung der Inhalte nach der Art der Information ergibt sich aus den m glichen Fragen des Anwenders die er zu einem bestimmten Thema stellen k nnte Fragt der Anwender beispielsweise nach der Funktionsweise erh lt er die Antwort in der Prozessbeschreibung Nach der IMAP Methode werden sieben Informationsarten unterschieden F r jede Informationsart wird eine bestimmte Form der Darstellung empfohlen vgl B hler 2008 S 153f Die folgende Tabelle zeigt die einzelnen Informationsarten die zugeh rigen m glichen Fragen und die empfohlene Darstellungsform Informationsart Frage Darstellung Anleitung Wie muss ich vorgehen Schritttabelle Entscheidungstabelle Flussdiagramm Prozess Wie funktioniert Stufentabelle Was geschieht wenn Tabelle Ursache Wirkung Beschreibender Text Struktur Welche Teile hat Grafik Wo und wie sind die Teile angeordnet Legende Begriff Was ist Texte in Form von Was bedeutet Definitionen Erl uterungen Beispielen Prinzip Was muss ich tun wenn Texte in Form von Was muss ich beachten wenn Sicherheitshinweisen mit Symbolen Voraussetzungen Fakt Was sind die Daten Date
116. sche Erstellung von Dokumentationen schaffen Die Qualit t einer Dokumentation sollte somit in erster Linie die Anforderungen der Anwender erf llen Romberg 2000 S 20 betont dass Technische Dokumentatio nen nicht zum Vergn gen gelesen werden sondern um Wissen und Fertigkeiten im Umgang mit dem Produkt zu erwerben und stellt folgende Anforderungen an Technische Dokumentationen zusammen Sachliche Richtigkeit aller Informationen ber das Produkt und aller Anwei sungen zu seiner Verwendung Keine inhaltlichen Widerspr che Keine Unklarheiten Vollst ndigkeit Notwendige aber keine berfl ssigen und unn tigen Informationen sind enthalten Alle Informationen f r die Verwendung des Produkts mit allen Funktio nen sind enthalten Verst ndlich dargebotene textliche und bildliche Informationen Ohne berm ige Anstrengung und ohne fremde Hilfe verst ndlich Klare Gliederung Unkomplizierte n chterne Sprache Ubersichtliche Grafiken und Tabellen und auf den Inhalt abgestimmtes Layout Einfache und logische Struktur in der die ben tigten Informationen schnell und einfach zu finden sind Navigationshilfen Inhalts Stichwort und andere Verzeichnisse Orientierungshilfen Seitenzahlen Kolumnentitel usw Inhalte sind aktuell auf das gelieferte Produkt hinsichtlich Funktionalit t und Ausstattung abgestimmt Produktindividuelle bzw produktserienspezifische Ausf hrung nderunge
117. schen Sachbuchverlags O Reilly vgl Kaspar 2006 S 100 1998 wurde DocBook von der Organization for the Advancement of Structured Information Standards OASIS als Standard verabschiedet und wird seit dem vom DocBook Technical Commitee gepflegt und weiterentwickelt vgl Hentrich 2008 S 77 F r DocBook existieren fertige DSSSL und XSL Stylesheets zur Ausgabe von Dokumenten in verschiedene Zielformate Zahlreiche Werkzeuge unterst tzen diesen Standard vgl Ferlein 2005 S 61 Das DocBook Format liefert eine umfangreiche DTD zur Beschreibung eines Inhalts anhand von logischen und physischen Strukturinformationen z B Band Reihe Abschnitt Metainformationen z B Autor Herausgeber sowie zahlreiche Beschreibungselemente f r technische Inhalte vgl Kaspar 2006 S 100 So lassen sich die Elemente der DocBook DTD grob in drei Gruppen aufteilen Hierarchie Metadaten und Informationen vgl Cyganiak 2003 S 14 F r die Auszeichnung der Dokumentenstruktur stehen etwa 50 Elemente zur Verf gung mit denen eine Hierarchie f r ein Buch aufgebaut werden kann Zur Auszeichnung der Metadaten k nnen etwa 100 Elemente verwendet werden und f r die technischen Informationen etwa 150 Elemente Dazu geh ren Elemente f r 19 Abs tze Tabellen Listen und f r die semantische Auszeichnung von Inhalten in den Bereichen Benutzeroberfl che Programmierung usw vgl Hentrich 2008 S 78 F r eine detailierte Beschreibung der meh
118. sion 1 0 unterst tzt Spezialisierungen bzw Erg nzungen der DITA Version 1 1 wie beispielsweise Bookmap oder Glossentry sind nicht enthalten Eine Integration des DITA Open Toolkits wird ber die Installation des frei verf gbaren Adobe Plug ins erm glicht F r weitere Bearbeitungs und Ausgabe m glichkeiten steht au erdem noch das DITA FMx Plug in von Leximation Inc zur Verf gung kostenpflichtig So erm glicht das FMx Plug in neben der Erstellung von ditaval Dateien Abschnitt 6 3 2 Metadaten f r die Verarbeitung auch die Verwendung des xref Mechanismus f r interne und externe Querverweise In den folgenden Abschnitten werden zun chst die DITA Funktionen und die Bestandteile der DITA Anwendungen beschrieben Die Integration des DITA Open Toolkits ber das Adobe Plug in wird in Kapitel 7 3 3 Weiterverarbeitung der DITA XML Dateien behandelt 6 6 1 DITA Funktionen Zur DITA Unterst tzung bietet FM Funktionen zur Import und Exportverarbei tung zur DITA Map Unterst tzung zur conref Unterst zung und zur Erstellung von FM Dokumenten und B chern aus DITA Map Dateien Die Import und Exportverarbeitung von DITA XML Dateien wird durch FM eigene Komponenten und Elemente erkennbar an dem Pr fix fm unterst tzt Um die Interoperabilit t mit anderen Systemen zu gew hrleisten werden die Dateien sowohl beim Import als auch bei Export in ein DITA konformes XML umgewandelt Der Import und Export geschie
119. t lt symbol href caution png gt lt hazardstatement gt Abbildung 6 Sicherheitshinweis mit dem lt hazard statement gt Element http www oasis open org committees download php 26390 IssueNumber12024 html 41 Das lt hazardstatement gt Element umfasst die Elemente lt messageplanel gt und lt symbol gt F r das Signalwort enth lt das Attribut type vordefinierte Werte unter anderen auch caution die optional zur Verf gung stehen Innerhalb des lt messageplanel gt Elements m ssen in vorgegebener Reihenfolge Art der Gefahr lt typeofhazard gt Folgen bei Nichtbeachten lt consequence gt Ma nahmen zur Vermeidung lt howtoavoid gt angegeben werden Das Piktogramm wird ber das Element lt symbol gt unter Angabe eines Verweisziels href eingef gt 6 1 4 Kombination der Topics F r die Zusammenstellung von Inhalten aus einzelnen Topics bietet DITA folgende M glichkeiten vgl Closs 2007 S 157 Verschachtelung von Topics Einbindung von Inhalten conref Mechanismus Verschachtelung von Topics Die Verschachtelung von Topics erfolgt au erhalb des lt body gt Elements und definiert die Reihenfolge und Hierarchie von beteiligten Topics Topics werden ineinander verschachtelt um gr ere zusammenh ngende Inhaltsbl cke zu erstellen concept title conbody E p task title taskbody B steps F step step Abbildung 7 Task Topic innerhalb eines Concept Topics 42 Diese Me
120. t DOCTYPE concept PUBLIC OASIS DTD DITA Concept EN atd topic dtd gt lt topic id beispiel gt lt title gt berschrift lt title gt lt body gt lt p gt lt p gt lt body gt lt topic gt Abbildung 3 Grundstruktur des generischen Topics 36 Ein DITA Topic beginnt mit einer XML Deklaration die in jeder XML Datei enthalten sein muss Darauf folgt die DOCTYPE Deklaration in der ein ffentlicher Bezeichner public indentifier den entsprechenden Topic Typ ber eine DTD referenziert Die Zuordnung des ffentlichen Bezeichners zu der entsprechenden DTD wird in der catalog dita xml Datei vorgenommen Nach dem ffentlichen Bezeichner wird ein Systembezeichner angegeben der verwendet wird falls der ffentliche Bezeichner nicht im DITA XML Katalog aufgef hrt ist Der Zugriff auf die DTD erfolgt dann ber eine relative Pfadangabe Die DTD wiederum verweist auf die Moduldatei in der die Elemente f r das entsprechende Topic definiert sind Der Topic Typ wird ber das Wurzelelement erkannt Das Wurzelelement umfasst das Pflichtelement lt title gt und das spezialisierte Element lt body gt Im Wurzelele ment muss ein Wert f r das Attribut id zugewiesen werden wodurch das Topic eindeutig identifiziert werden kann Nach dem Wurzelelement folgt das Pflichtelement lt title gt Das lt title gt Element wird verwendet um einem Topic einen Titel bzw eine berschrift zu vergeben In den Ausgabe
121. t und Aufbau der Inhalte f r die sie gedacht sind und legen fest wie sie zu verwenden sind Beispielsweise stehen im lt taskbody gt die Elemente lt prereq gt Handlungs vorbereitung lt context gt Hintergrundinformationen lt steps gt Handlungs schritte lt result gt Handlungsresultat und lt postreq gt Handlungs nachbereitung zur Verf gung Das lt taskbody gt Element darf nur einen Handlungsblock lt steps gt aber beliebig viele Handlungsschritte lt step gt enthalten Kennzeichnend f r das Reference Topic sind das lt properties gt Element zur Erfassung von Referenzinformationen in einer vordefinierten Tabelle und das lt refsyn gt Element f r Syntaxbeschreibungen F r Angaben zu beispielsweise Technischen Daten eines Produkts steht das lt table gt Element zur Verf gung Das aus dem Concept Topic spezialisierte Glossentry Topic enth lt kein lt body gt Element Nach dem lt title gt Element k nnen mehrere lt glossterm gt Elemente eingef gt werden in denen jeweils ein zu definierender Glossareintrag im lt glossdef gt Element erfasst wird 38 F r das Concept Topic selbst sind keine spezifischen Strukturelemente definiert Daher sollten Vorgaben f r die Verwendung festgelegt werden wie die Hinter grund Informationen zu strukturieren sind 6 1 3 Domains zur Auszeichnung von Inhalten Neben den Strukturelementen der Topics stehen Elemente zur semantischen und typografisch
122. thode bietet sich an wenn die einzelnen Topic Inhalte zueinander im Zusammenhang stehen und demzufolge immer zusammengeh ren vgl Closs 2007 S 157 Sollen die einzelnen Topics oder deren Inhalte an einer anderen Stelle wieder verwendet werden ist zu empfehlen die Topics getrennt zu verwalten und ber den conref Mechanismus content reference in ein anderes Topic einzubinden conref Mechanismus Mit dem conref Mechanismus werden Inhalte in Informationsstrukturen referenziert und k nnen somit wieder verwendet werden Jedes Element das eine ID aufweist kann ber das conref Attribut in folgenden Informationsstrukturen referenziert werden Topics Elemente innerhalb eines Topics Elemente innerhalb einer Map Die M glichkeiten werden im Folgenden n her erl utert lt topic id topic id gt lt concept id eigene id conref dateiname concept id gt lt concept id concept id gt i i lt title gt lt title gt externe Datei externe Datei lt title gt lt title gt lt concept gt lt concept gt lt topic gt Abbildung 8 Topic aus einer externen DITA XML Datei referenzieren Wird auf ein Topic einer externen DITA XML Datei verwiesen werden dem conref Attribut die Werte Dateiname der externen Datei und anschlie end die Topic ID des zu referenzierenden Topics vergeben Der Dateiname und die Topic ID werden durch das Rautenzeichen getrennt 43 lt concept id concept id gt lt bo
123. tight fit Secure hexagon screw heads with a wrench and tighten hexagon nuts crosswise to a torque of 145 5 Nm Repeat steps 4 and 5 twice 7 Fill the hollow space between the screws and bores on the lower muff with AUTOL TOP 2000 corrosion protection 4 1 4 Finaly activity Check the air pipe connection for leakage no hissing noise 4 2 Separation of coupler halves For safety reasons all screw connections must be replaced when the muffs couplings are di sassembled or the screws got loose during operation C NOTE The muff coupling used for connecting the two coupler halves is part of the coupler half 2 035 167 and should therefore be left on that coupler half after separating the cars 4 2 1 Tools and materials standard tools lifting crane with a sufficient lifting capacity lifting straps trestle 4 2 2 Preparation 1 Support the coupler halves with a lifting crane 2 Separate the air pipe between the coupler and the car Version 1 04 04 Page 4 11 OPERATING INSTRUCTIONS 4 2 3 Disassembling the muff coupling Loosen hexagon nuts Pull off lock washers Pull off hexagon head screws from muffs Loosen muffs by tapping them slightly with a hammer place a piece of wood underneath Move the cars apart OF 2 0 Nas Version 1 04 04 Page 4 12 MAINTENANCE 5 Maintenance 5 1 General To be observed before starting any maintenance or repair works A WARNING Danger to hea
124. timmt Aufgabe bew ltigen kann In den Reference Topics werden Tabellen oder Parameter Listen f r Referenzin formationen und Technische Daten erfasst und beantwortet die Fragen welche Werte oder Eigenschaften ein Produkt oder Produktteile haben 35 F r beschreibende Informationen wird das Concept Topic verwendet Es kann beispielsweise eine Beschreibung zum Produkt bzw zu Produktteilen und zur Funktion enthalten oder Uberblicksinformationen vermitteln Dem Anwender wird die Frage Was ist beantwortet vgl Hentrich 2008 S 20 Eine Spezialisierung des Concept Topics ist wie bereits erwahnt das Glossentry Topic Dieser Topic Typ steht seit der DITA Version 1 1 zur Verf gung und ist f r Begriffsdefinitionen gedacht Es beantwortet die Frage Was bedeutet vgl Hentrich 2008 S 20 Die spezialisierten Topic Typen haben eine einheitliche Struktur mit gemeinsamen Elementen Anhand des generischen Topics wird im folgenden Abschnitt zun chst der Aufbau der DITA Topics beschrieben Die spezifischen Strukturelemente die die einzelnen Topic Typen kennzeichnen werden in den darauffolgenden Abschnitt behandelt 6 1 1 Aufbau der Topics Das DITA Informationsmodell basiert auf Vererbung Die Topics Typen haben eine gemeinsame Basisstruktur deren Merkmale sie erben Der Aufbau soll im Folgenden anhand der Grundstruktur des generischen Topics erl utert werden lt xml version 1 0 encoding UTF 8 gt l
125. ts gekennzeichnet Sowohl dem lt p gt Element als auch dem lt 1li gt Element wird ber das Attribut id ein Wert zugewiesen mit denen beide Elemente eindeutig identifiziert werden k nnen SCH_tools and materials xml lt gt Tools and materials ktandard tools lifting crane with a sufficient lifting capacity of 400 kg lifting crane with a sufficient lifting capacitiy lifting straps trestle AMASSAA lifting straps torque wrench hammer Tools and materials gt SMR BRo SCH_standard tools topichi standard tools Dok SCH_tools and materials xml Textfluss A 100 z Z Textfluss A E ul 1von1 100 z ZAB Abbildung 29 Quelldokument Tools and materials 76 F r das Modul Tools and materials aus dem Beispielkapitel wird ein neues Topic erstellt das die Werkzeuge enthalten soll die f r die Ausf hrung der Handlung en ben tigt werden Dazu wird ber den conref Mechanismus auf die lt 1i gt Elemente im Quelldokument mit den entsprechenden Eintr gen verwiesen Das lt li gt Element muss im Zieldokument an der Einf geposition g ltig sein Mit dem Befehl DITA gt Conref einf gen wird das Dialogfenster DITA Verweisverwaltung ge ffnet DITA Verweisverwaltung Se Quelldatei E Projects contents_DITANSCH_tools and mat Durchsuchen Bearbeiten Element Tag Elementdaten id content nn SCH_standard tools standard tools a SCH_crane
126. ts list section Materials are used If any other materials are used Voith Turbo Scharfenberg cannot be held liable for any resulting consequential damages 7 1 Workshop equipment The handling of major subassemblies requires the availability of one or two overhead travelling cranes of sufficient lifting capacity lifting straps and trestles do not use chains which might da mage the coupler Any special tools and aids required for corrective maintenance are mentio ned at the beginning of every section The following standard tools and standard materials are not mentioned expressly Tools e set of screwdrivers e fitter s hammers 500 1000 g e chisels e set of wrenches e set of ring wrenches set of hexagon socket screw keys e torque spanners adjustable set of drift punches e ejector drifts for bushes e pliers for retaining rings Materials e paint brushes compressed air oil free e cleaning rags e brushes e spattle non resin penetrating oil e artificial resin paint e pocket lamp e spirit level e calibre e protractor e calliper gauge e continuity checker Version 1 04 04 Page 7 18 MOUNTING AND REPAIR INSTRUCTIONS 7 2 Installation of the coupler half 7 2 1 Tools and materials e standard tools lifting crane with a sufficient lifting capacity of 400 kg spirit level lifting straps 7 2 2 Preparation ar NOTE The anchoring plate for the coupler half on th
127. uch die FM eigenen Funktionen f r die Bearbeitung und Formatierung der Dokumente zur Verf gung stehen So k nnen der Absatz und Zeichenkatalog zur Textformatierung verwendet werden Zeilen und Seitenumbr che eingef gt werden Schriftfarbe ge ndert werden usw Diese Informationen gehen allerdings beim Import und Export verloren Wo und wie diese Festlegungen getroffen werden soll im folgenden Abschnitt beschrieben werden 58 6 6 2 DITA Anwendungen Adobe FrameMaker 8 FM bietet einige vordefinierte Strukturanwendungen fiir SGML und XML die sich im Unterverzeichnis Structure des Programmverzeichnis ses von FM befinden Als XML Anwendung werden neben den Standards wie DITA oder DocBook auch weitere vordefinierte Strukturen angeboten die als Grundlage f r eine strukturierte Dokumenterstellung verwendet werden k nnen Die DITA Unterst tzung in FM umfasst folgende drei Anwendungen DITA Topic FM f r das Erstellen und Bearbeiten von Topics DITA Map FM f r das Erstellen und Bearbeiten von Maps DITA Book FM f r das Erstellen von FrameMaker B chern aus DITA Maps Die Anwendungen sind modular aufgebaut Die einzelnen Bestandteile einer DITA Anwendung sind vgl Kr ger K 2008 S 247 Anwendungsdefinition DTD Document Type Definition Lese Schreibregeln read write rules strukturiertes Template mit getrenntem EDD Element Definition Document XSL Verarbeitungsdateien wenn erforderlich f
128. ug ins in den DITA Open Toolkit Ordner abgelegt wurde Mit diesem Script wird aus einem Topic oder aus einer Map und den XSLT Stylesheets das gew hlte Ausgabemedium generiert Damit die Ausgabe Dateien im Zielordner out abgelegt werden muss die Script Datei ditafm ant xml entsprechend angepasst werden 86 lt target name html i description build the html output depends init project gt mkdir dir E file separator jProjects file separator jout file separator jhtml gt i santcall target dita2xhtml gt lt param name args input i i yalue E file separator Projects file separator contents_DITA file separator project ditamap gt if lt param name output dir i i i values E file separator Projects file separator jout file separator html gt i lt fantcall gt lt harget Abbildung 40 Aus DITA XML Dateien XHTML Dateien erzeugen F r die Transformation nach XHTML wird das XSLT Stylesheet dita2xhtml xml verwendet das sich im xsl Verzeichnis des DITA Open Toolkit befindet Zusatzlich werden zwei CSS Dateien zur Verfiigung gestellt in denen nachtraglich Formatie rungsregeln f r das Layout definiert werden k nnen commonltr css Schriftverlauf von rechts nach links commonrtl css Schriftverlauf von links nach rechts Sollen aus eigenen in FrameMaker erstellten XML Dateien und XSLT Stylesheets HTML CHM oder PDF Dateien generiert werden muss im Dialogfenste
129. ult in damage or destruction of the components and impair ment of its function NOTE Useful tips and information for the perfect use of the equipment Version 1 04 04 Page 1 1 SAFETY PRECAUTIONS 2 Safety precautions To be read and understood before putting coupler into operation 2 CAUTION Risk of damage to coupler halves Make sure that semipermanent coupler halves are compatible before connection gt CAUTION Risk of damage to air pipes When two semipermanent coupler halves are connected with muff coupling in horizontal position air pipes might be damaged Install muff coupling vertically Version 1 04 04 Page 2 2 COMPONENTS DESCRIPTION AND FUNCTION 3 Components Description and function 3 1 Technical data Compressive strength Yield strength Rpo 2 1 250 KN Tensile strength Yield strength Rpo 2 850 kN Coupler length from face to pivot 1 180 5 mm Coupler weight excluding cables approx 250 kg Collapsible tube Stroke on buff approx 150 mm Impact load on buff approx 1 100 kN Energy absorption dyn on buff approx 165 kJ Rubber cushion drawgear Stroke on buff approx 55 mm Stroke on draft approx 40 mm Spring resistance static on buff approx 680 kN 10 Spring resistance static on draft approx 390 kN 10 Energy absorption static on buff approx 14 1 kJ Energy absorption static on draft approx 7 1 kJ Maximum swing of coupler Horiz
130. w doku info print viewarticle php art 37 Abruf 2008 10 25 2007 Single Source Publishing Topicorientierte Strukturierung und DITA Paderborn entwickler press 2007 ISBN 978 3 935042 98 7 Cyganiak Richard 2003 Publishing mit XML Open eBook und DocBook Freie Universit t Berlin Institut f r Informatik 2003 URL _ http richard cyganiak de 2003 xml oeb_docbook Abruf 28 10 2008 93 Enders Micheal und Wolff Thomas 2008 Inhalte und Strukturen eines Redaktionsleitfadens Sie haben Ihr Ziel erreicht Fachzeitschrift fiir Technische Dokumentation und Informationsmanagement 2008 04 S 18 24 Ferlein J rg 2005 Redaktionssysteme und Single Source Publishing Inhalte flexibel und zielgruppengerecht publizieren Schenkenzell GFT GmbH 2005 ISBN 978 3 938334 44 7 Fritz Michael 2008 CMS geht die Reise hin newsletter zur tekom Jahrestagung 2008 Ausgabe 01 S Seite 1 2 2008 CMS wo geht die Reise hin newsletter zur tekom Jahrestagung Juli 2008 Ausgabe 01 S 1 2 Fritz Michael et al 2008 DITA in der Technischen Dokumentation eine Entscheidungshilfe f r den Einsatz Stuttgart tekom e V 2008 Hentrich Johannes 2008 Der neue Standard f r Technische Dokumentation 1 Ausgabe M nchen XLcontent Verlag 2008 978 3 98114 300 3 Hoffmann Walter und H lscher Brigitte G 1994 Erfolgreich beschreiben Praxis des Technischen Redakteurs 2 berarbeitet und erweiterte Auflag
131. wenden zu k nnen Fehlen diese Informationen ist dies meist aufgrund der gro en Menge an Topics nur schwer oder sogar nicht m glich sollen beispielsweise aus einem Topic Bestand diejenigen verwendet werden deren Inhalte f r eine spezifische Zielgruppe bestimmt sind oder zu einer bestimmten Produktversion geh ren 47 F r Metadaten die f r die Verwaltung von Informationen verwendet werden sind in DITA zahlreiche Elemente definiert ber diese Elemente k nnen einzelne Topics und Maps durch Zusatzinformationen gekennzeichnet werden Dazu sollten klare Vorgaben definiert werden welche Metadaten in welcher Form aufgenommen werden m ssen und welche Metadaten optional sind Das Erfassen der Metadaten kann durch unterschiedliche Methoden unterst tzt werden vgl Hentrich 2008 S 68 Festlegungen im Redaktionsleitfaden Anpassung der DTD Elemente f r Metadaten zu Pflichtfelder erkl ren Unterst tzung durch eines externen Systems CMS das das Fehlen von Metadaten nicht erlaubt Eine Orientierung f r den Redaktionsleitfaden bietet die IMAP Methode Sie empfiehlt bei der Festlegung von Metadaten die gleiche Vorgehensweise wie bei der Bestimmung der Informationsarten Kapitel 5 3 Information Mapping Demnach k nnen auch f r die Metadaten werden Fragen aus der Sicht der Anwender formuliert werden vgl B hler 2006 S 136 F r die Metadaten in Maps und Topics werden nahezu die gleichen Elemente zur V
132. with a lifting crane and straps and align it with the anchoring i plate a o CAUTION Parts can get loose Seat engaging surfaces for screws and nuts must bei f free from paint and grease in order to ensure correct tightening a in NOTE Forthe installation of the coupler half also refer to the current installation require ments of the car builder 3 Install the coupler half according to the current installation requirem ents of the car builder 4 Lay the air pipe in such a way that it does not handicap the free horizontal and vertical E Strukturansicht 2 J Eemien z tester J a enone 1 Make sure that the holes in t a Sen Feot stepresult C10 fl re 2 2 Support the coupler half with para tutorialinfo Istepsmp 4 f Parts can get loose Seat engagi For the installation ofthe coup Einfigen Dok SCH_install coupler_installing coupler xml Textfl 120 z ZAB r Textfluss A E step 1 von 1 100 zZ B gt Abbildung 36 Sicherheitshinweise vor einem Handlungsschritt Die bereits im Abschnitt 6 1 3 Domains zur Auszeichnung von Inhalten vorgestell ten Strukturierungsvorgaben f r Sicherheitshinweise des Unterarbeitskreises Maschinenbau werden derzeit diskutiert und gegebenenfalls in der Version 1 2 des DITA Standards aufgenommen 83 7 3 2 Erstellen einer DITA Map und Generieren eines FrameMaker Buches Ein
133. xte und Seitenlayouts f r die Dokumente enthalten Dazu geh ren beispielsweise die Formate der Vorgabeseiten in denen die Variablen f r beispiels weise Kopf und Fu zeile enthalten sind chapter template fm 1 von 1 un z ZB Abbildung 21 Strukturiertes Template F r die DITA Anwendungen sind die Templates ebenfalls im Standardumfang von FrameMaker enthalten F r die eigenen Dokumentanforderungen m ssen die Formatierungsvorgaben angepasst werden Dies gestaltet sich bei der Anzahl an verf gbaren DITA Elementen recht aufwendig da jedem DITA Element ein Format zugewiesen ist 64 7 Dokumentationserstellung mit DITA in Adobe FrameMaker 8 Bei der Erstellung der Dokumentation wurde weitgehend versucht die Dokumenta tion weniger an das DITA Konzept anzupassen sondern es galt zu berpr fen ob mit dem DITA Informationsmodell die Strukturierungsanforderungen Technischer Dokumentationen von Schienenfahrzeugen und auch Fahrzeugkomponenten erf llt werden k nnen Die Vorgehensweise und einzelne Arbeitsschritte werden in den folgenden Abschnitten beschrieben Abschlie end soll das Ergebnis ausgewertet werden 7 1 Ausgangssituation und Festlegungen Untersuchungsgegenstand der Diplomarbeit ist ein englischsprachiges Benutzer handbuch einer halbautomatischen Kupplung der Firma Voith Turbo Scharfenberg GmbH amp Co KG SCHAKU Das Benutzerhandbuch liegt in Word Dokumenten vor Mit den b
134. zur Verf gung wie vgl Fritz et al 2008 S 22 Another Neat Tool ANT XML Katalog Resolver Formatting Objects Processor FOP XEP von RenderX XSLT Prozessor Xalan F r die Generierung von Inhalten in verschiedene Ausgabemedien werden die Programme Microsoft HTML Help Workshop und JavaHelp Prozessor ben tigt In das DITA Open Toolkit k nnen zus tzlich Programme und Stylesheets von externen Anbietern eingebunden werden Ein bekanntes Plug in ist das FO Plug in von Idioms Technologies Inc das XSLT Stylesheets zur Generierung von PDF Dateien anbietet In der aktuellen DITA Open Toolkit Version 1 4 werden f r die Generierung von PDF Dateien die XSLT Stylesheets des FO Plug ins bereits verwendet vgl Hentrich 2008 S 30 Sie k nnen an die eigenen Anforderungen angepasst werden wobei Kenntnisse in XSLT ANT und XSL FO erforderlich sind 51 Die Installation die Arbeitsumgebung im Dateisystem und auch die Bedienung ber die Kommandozeile stellen anfangs eine besondere Herausforderung dar Insbesondere dann wenn Redakteure die Dokumentationen zuvor ausschlie lich in Textverarbeitungssystemen wie Adobe FrameMaker oder Microsoft Word erstellt haben Inzwischen stellen XML Editoren mit einer DITA Unterst tzung komfor table Werkzeuge Hentrich 2008 S 293 f r die Dokumentationserstellung dar 6 4 1 XML Editoren Editoren die eine Erstellung und Bearbeitung von DITA XML Dateien erm glichen si
135. zwei Welten wachsen zusammen Aus der Kaserne ins Klassenzimmer technische kommunikation 2008 01 S 18 22 Romberg Markus 2000 Konzept und Entwicklung eines Redaktionssystems zur Produktion von Anwenderdokumentationen Anwendergerechte Online und Papierdokumentation aus einer Datenquelle Maschinenbau und Verfahrentechnik Universit t Kaiserlautern Kaiserlautern Fortschritt Berichte pak 1 Univ 2000 ISBN 3 925178 36 8 Sch flein Armbruster Robert 2006 Die _Standardisierungsmethode Funktionsdesign 2006 Schmidt Axel 2006 Das Multimediale Maschineninformationssystem mumasy Ein Sog muss entstehen Produkt Global 2006 04 S 24 25 2006 Kataloge erstellen Den berblick behalten Produkt Global 2006 01 www oasis open org 2008 DITA Proposed Feature 12024 Hazard Statement Domain Online 2008 URL _ http www oasis open org committees download php 26390 IssueNumber12024 html Abruf 2008 09 16 Ziegler Wolfgang 2007 Modularisierung von Produktdokumentationen Die richtige Gr e finden Produkt Global 05 2007 S 22 25 Ziegler Wolfgang und Kr ger Manfred 2008 Standards f r strukturierte technische Informationen ein berblick Buchverf J rgen Muthig Standardisierungsmethoden f r die Technische Dokumentation L beck Verlag Schmidt R mhild 2008 Bd 16 95 Eidesstattliche Erklarung Ich versichere dass ich die Arbeit selbstst ndig angefertigt keine anderen als die

PDF-Version - FB IKS - Hochschule Merseburg

Contents

Download Pdf Manuals

Related Search

Related Contents