|
|
| Zeile 2: |
Zeile 2: |
| | | | |
| | | | |
| | + | Bitte nicht ändern, der Artikel ist noch nicht abgeschlossen. |
| | == Technische Dokumentation und Redaktion == | | == Technische Dokumentation und Redaktion == |
| | | | |
| − | '''Aufgabe:''' Die technische Dokumentation dient als Informationsressource für den Kunden (Nutzer) und den Hersteller. Sie soll alle notwendigen und zweckdienlichen Informationen über ein Produkt (Gegenstände, Dienstleistungen) und seine Verwendung sammeln und dabei inhaltliche Konsistenz, Austauschbarkeit und Wiederverwendung, die gerade bei sehr umfangreichen Dokumentationen sehr stark ins Gewicht fällt, gewährleisten. <br>Das geschieht meistens auf einer grafischen Ebene, die eine optische Unterteilung bedeutet, welche auf das gesamte Dokument bezogen ist.
| + | Der Beitrag wird noch einmal komplett überarbeitet und dann neu ins Netz gestellt. |
| − | | + | Da dies einige Tage dauern wird, bitte ich um etwas Geduld. |
| − | Technische Dokumentation = Dokumentation von technischen Systemen in strukturierter Form (auf Papier oder als elektronisches Medium).
| |
| − | | |
| − | Man kann in der technischen Dokumentation zwei Bereiche erkennen, zum einen die '''Entwicklungsdokumentation''', sie umfasst: <br>- Angebotsdokumentation, <br>- Lasten-, Pflichtenhefte, <br>- Entwicklungsdokumentation, Software- und Hardwareunterlagen.
| |
| − | | |
| − | Zum anderen den '''Aufgabenbereich des technischen Redakteurs''', der mit der Entwicklung folgender Dokumentationseinheiten beschäftigt ist: <br>- Produktunterlagen <br>- Bedien-Handbücher <br>- Anleitungen <br>- Service- und Wartungshandbücher <br>- Warnhinweisen an Maschinen <br>- Qualitätsmanagementhandbücher <br>- Schulungsmaterialien <br>- Online-Hilfe und - Online-Dokumentation
| |
| − | | |
| − | '''Diese Aufgaben verlangen eine professionelle Ausführung, weswegen der Beruf des technischen Redakteurs geschaffen worden ist.''' <br>Zur Unterstützung dieser redaktionellen Arbeit werden Redaktionssysteme und Content-Management-Systeme angewendet.
| |
| − | | |
| − | | |
| − | === Vorgehensweise und Hindernisse ===
| |
| − | | |
| − | ====Seiten- und Dokumentenmetapher====
| |
| − | Mit der Benutzung der meisten Texterfassungs- und DTP-Programme werden Präsentationselemente durch die Seiten des Dokuments definiert. D.h. eine Dokumentseite ist ein Präsentationselement. Die dokumentarischen Bezugseinheit, die dem gesamten Dokument entspricht, wird also nach gestalterischen Gesichtspunkten oberflächlich gegliedert. Man spricht dann von der Seiten- und Dokumentenmetapher
| |
| − | | |
| − | | |
| − | ==== Seitenorientierte Navigation/Sprungziel ====
| |
| − | | |
| − | Dadurch steht der gestalterische Aspekt an erster Stelle und nicht der Inhalt, es kann zu Problemen bei der seitenorientierte Navigation kommen.
| |
| − | In manchen Viewern kann nach dem Anklicken eines Links lediglich der Seitenanfang der betreffenden Seite als Sprungziel erreicht werden und nicht der Link selbst.
| |
| − | | |
| − | | |
| − | ==== Mangel an Methodik und Systematik ====
| |
| − | | |
| − | Auch wenn man verschiedene Programme des DTP vergleicht, kann man einen Mangel an Methodik und Systematik (Vorschrift) feststellen. Will man also ein und das selbe Ergebnis mit verschiedenen DTP-Programmen erreichen, muss man dazu ganz unterschiedliche Wege mit unterschiedlich benannten Komponenten gehen, die eigentlich die gleichen Funktionen beinhalten.Eine Verbesserung könnte hier z.B. durch eine zumindest teilweise Normierung, z.B. im Bereich der Begrifflichkeiten erreicht werden.
| |
| − | | |
| − | | |
| − | ==== Konvertierung/Informationsverlust ====
| |
| − | | |
| − | [[Konverter|Konvertierung]] bedeutet meist Informationsverlust. Wenn man offene DTP-Dateiformate zum Datenaustausch konvertiert, gehen dabei wichtige Informationen und globale Bearbeitbarkeit des [[Layout|Layouts]] verloren.<br>- (Wiederverwendbarkeit der Informationen <br>- formateigene Gestaltungsmöglichkeiten <br>- Anordnung der Gestaltungs- bzw. Textelemente im Dokument etc. ...)
| |
| − | | |
| − | | |
| − | ==== Dokument-Management-Systeme ====
| |
| − | | |
| − | Dokument-Management-Systeme dienen dazu Versionen und Varianten zu verwalten, Zugangsberechtigungen und die Freigabe von Dokumenten zu kontrollieren, besitzen die Möglichkeit des Änderungs- und Revisionsmangements und zu geringer Workflow-Funktionalität. Bei den Dokument-Management-Systemen werden also Files Verwaltet und nicht Informationen, das bedeutet, dass der Zugriff auch nur über Dokumentenbeschreibungen erfolgen kann und nicht über eine logische Struktur der Files.
| |
| − | | |
| − | Als Nachteil ist zu betrachten, dass die konventionellen Dokument-Management-Systeme auf eine Nutzung der Erkenntnisse aus dem Bereich der Datenbank-Technologie verzichten.
| |
| − | Das sind zum Beispiel: <br>- Datenstrukturierung <br>- Redundanzfreiheit <br>- zentraler Zugriff <br>- benutzerspezifische Views <br>- Normalisierung Das fehlen dieser Strukturen kann zu Schwierigkeiten bei der Wiederverwendung und Ähnlichkeitsnutzung der Dokumente führen.
| |
| − | | |
| − | Das speichern von [[XML]] Daten ist zwar möglich, aber das Übernehmen dieser Daten in den Printbereich ist immer noch nicht reibungslos durchführbar. Das betrifft auch [[CSS]] (Cascading Style Sheet) und XSL (Extensible Style Sheet Language).
| |
| − | | |
| − | | |
| − | ==== Informationsretrieval ====
| |
| − | | |
| − | Das [[Information Retrieval|Informationsretrieval]] ist von einigen Widrigkeiten beeinflusst. Bei längeren, inhaltlich wenig strukturierten Dokumenten steht ihm die layoutorientierte Gliederung der Dokumente im Weg. Die besten Ergebnisse werden daher bei der Suche mit [[Abstracting|Abstracts]] erzielt. Es ist dringend notwendig, den zu erschließenden Text schon bei der Erstellung inhaltlich zu gliedern und dabei eine stringente Trennung vom Layout beizubehalten.
| |
| − | | |
| − | | |
| − | | |
| − | ==== World Wide Web – Elektronisches Publizieren ====
| |
| − | | |
| − | Die Seiten des WWW stützen sich meist auf den Aufbau durch [[HTML]], sind somit also gestaltungsorientiert angelegt. Jeder Autor kann den Aufbau frei nach seinen Vorstellungen gliedern, so dass keine wirkliche Konsistenz entstehen kann. Eine Suche nach inhaltlichen Strukturen und ein damit verbundenes Qualitätsmanagement (ob eine Seite an einer Stelle bestimmte, dort notwendige Daten enthält) wird somit unmöglich.
| |
| − | | |
| − | Das WWW bietet die Möglichkeit mit Hilfe von Plug-Ins Formate wie [[PDF]] darzustellen, die zwar angezeigt, gelesen und gedruckt werden können, deren Durchsuchbarkeit allerdings stark eingeschränkt ist, was eine Indexierung durch Suchmaschinen erschwert oder unmöglich macht (es wird eine Software zur Konvertierung, sprich Lesbarmachung für die automatische Indexierung erforderlich). Auch die Nutzung von Browsern, die nur spezielle HTML-/XML Sprachvarianten verarbeiten, schränkt den Zugriff auf weltweit gesuchte Informationen ein.
| |
| − | | |
| − | Da das WWW inhaltlich keine Strukturierung besitzt, sind seine Daten zur maschinellen Weiterverarbeitung oder Verwaltung publizierter Informationen ungeeignet. | |
| − | | |
| − | | |
| − | ==== Konsistenzproblematik/Dokumentenaustausch ====
| |
| − | | |
| − | Gemeint ist die Konsistenz des Dokumenteninhalts, sie kann dadurch verletzt werden, dass Änderungen nicht konsequent an allen davon betroffenen Stellen durchgeführt werden. Man kann drei Klassen von inhaltlichen Bezügen unterscheiden: <br>- Wiederverwendung <br>- Querverweise und <br>- sonstige Bezüge. <br><br>Es muss bei der Wiederverwendung darauf geachtet werden, dass bei Änderungen alle Stellen im Text, die von diesem Thema betroffen sind, mit einbezogen werden.
| |
| − | Auch bei Übersetzungen spielt das eine Rolle, die Modifikationen im Originaldokument müssen erneut übersetzt werden, um sie in den anderssprachigen dokumentarischen Bezugseinheiten zu aktualisieren.
| |
| − | | |
| − | | |
| − | === Randbedingungen/Kundenanforderungen ===
| |
| − | | |
| − | Eine Technische Dokumentation macht es möglich technisches Wissen zwischen Hersteller und Nutzer zu kommunizieren. Sollte es sich um langlebige Produkte handeln, muss der Kunde auch noch nach Jahren auf die technische Dokumentation zugreifen können. Daher ist es wünschenswert die zur Sichtung dieser Daten notwendigen Applikationen ebenso aufzubewahren. Das amerikanische Verteidigungsministerium forderte bereits in den 1980er Jahren ein Format, das herstellerunabhängig eine Darstellung der technischen Dokumentation erlaubt. Grundlage war schon damals SGML, ein ISO Standard.
| |
| − | Heute wird XML, als vereinfachte Untermenge von SGML, gerne zu diesem Zweck herangezogen.
| |
| − | | |
| − | Es gab und gibt in verschiedenen Branchen aber auch branchenübergreifend Bemühungen technische Dokumentationen durch SGML, XML oder andere Standards zu vereinheitlichen, um den Kunden eine einfachere Nutzung zu ermöglichen.
| |
| − | | |
| − | Das [[W3-Konsortium|W3C]] World Wide Web Consortium folgt mit der seit 1996 bestehenden Initiative der Bestrebung mit XML bzw. XSL eine Möglichkeit zu schaffen im Internet Informationselemente zu publizieren und nicht nur darstellungsorientierte HTML-Seiten.
| |
| − | | |
| − | | |
| − | ==== Qualitätsmanagement ====
| |
| − | | |
| − | Die Normen der EN ISO 9000 legen die Parameter des Qualitätsmanagements in der Form fest, dass sie Dokumentation von Verfahrensweisen, Ergebnissen und Produkten festlegen. Sie sind außerdem im Hinblick auf die Produkthaftung von großer Wichtigkeit. Im Kapitel 4 geht es um <br>- Forderungen an die Qualitätssicherung/Qualitätsdarlegung, in <br>- Kapitel 4.4 um Designlenkung, <br>- Kapitel 4.5 beschäftigt sich mit der Lenkung der Dokumente und <br>- 4.16 mit der Lenkung von Qualitätsaufzeichnungen. <br>- Die Norm enthält keine konkreten Vorgaben für die Art, die Ausführung und den Umfang von Dokumenten, jedoch gibt es übergreifende Ansprüche, wie z.B. „[...] dass Dokumente mit korrektem Ausgabestand und richtigen Inhalt zum richtigen Zeitpunkt am richtigen Ort sind.[...]“
| |
| − | | |
| − | Des weiteren ist anzumerken, dass die technische Dokumentation auch ein Teil eines Produktes darstellt und somit der Mindestgewährleistungsfrist für Handelsprodukte untersteht. Wenn in der Technischen Dokumentation also Fehler enthalten sind, die auf die Nutzung Einfluss haben, gilt dies als Mangel des Produktes mit den dadurch entstehenden Kosten für den Hersteller.
| |
| − | | |
| − | | |
| − | ==== Content-Managment-Systeme ====
| |
| − | | |
| − | Die Anwendung von Content-Managment-Systeme basiert auf der Absicht, dass der Redakteur sich nur noch dem Inhalt der Dokumente widmen muss. Erreicht wird das durch die Trennung von Inhalt und Layout. Wie beispielsweise bei SGML oder XML. Ziel soll es sein, die Dokumente nach Sinn bzw. Inhalt zu ordnen und sie mittels Stilvorlagen und Seitenlayouts dann einem oder verschiedenen Veröffentlichungswegen, z.B. Print oder Web zuzuführen. Deshalb werden oft (Internet-)Redaktionssysteme auch als (Web-)Content-Management-Systeme sinngleich verwendet.
| |
| − | | |
| − | | |
| − | === Neues bei der technischen Information und Dokumentation ===
| |
| − | | |
| − | ==== Inhaltliche Strukturierung der Dokumente ====
| |
| − | Wird dadurch erreicht, dass man <br>- Informationen strukturiert, indem man logischen Inhalt und grafische Darstellung trennt <br>- die Anordnung von Dokument- und Informationen gliedert <br>- Konzepte und Methoden für die Wiederverwendung entwickelt
| |
| − | '''Ziel ist es Kundenanforderungen und Qualitätsmanagement zuzuarbeiten.'''
| |
| − | | |
| − | | |
| − | ==== Konsistenzproblematik ====
| |
| − | Es wird von Konsistenzproblematik gesprochen, wenn Änderung nicht konsequent an allen Stellen gemacht werden, die davon betroffen sind. Es gibt semiautomatische Verfahren, die Autoren von Dokumentationen hinsichtlich der Konsistenzproblematik unterstützen, sofern diese mit coded informations arbeiten.
| |
| − | | |
| − | | |
| − | ==== Finden von Informationen ====
| |
| − | Um ein möglichst verlustarmes Retrieval anzustreben, sollte man darauf achten, eine hard- und softwareunabhängige Dokumentationsarchitektur aufzubauen. Das kann beispielsweise mit SGML/XML erreicht werden. Es werden inhaltliche Teile festgelegt, die der Nutzer bei seiner Suche ansprechen kann. Damit wird die Indexierung ersetzt durch die inhaltliche Beschreibung von thematischen Zusammenhängen der Dokumente.
| |
| − | | |
| − | | |
| − | ==== Dokumentenaustausch/Durchgängigkeit ====
| |
| − | Durchgängigkeit der Arbeitsprozesse durch Dokumentenaustausch kann dadurch erreicht werden, dass Informationen einzelner Dokumente wiederverwendet und/oder automatisch weiterverarbeitet werden. Möchte man die Möglichkeit für diese Vorgänge schaffen, muss darauf geachtet werden, dass die Dokumente nach logischen Faktoren kodiert, also die selben Formate benutzen und einheitlichen beschrieben sind (z.B. XML).
| |
| − | | |
| − | | |
| − | ==== Automatisierte Erzeugung von Dokumentationen ====
| |
| − | Bei der Erstellung einer Dokumentation erhält der Autor eine gewisse Arbeitserleichterung durch die Texterfassungssoftware, die meist in der Lage ist, verschiedene Verzeichnisse zu erstellen. Weitere Automatisierung kann stattfinden, wenn im vorhinein klar ist, welche Informationen möglich und welche notwendig sind, in diesem Fall können diese in eine leere Vorlage mit der gewünschten Struktur der neuen Dokumentation einfließen. Man kann hier die Qualitätssicherung durch Standardisierung erkennen, die sich zudem auch kostensparend auswirkt, da hierdurch geringerer Aufwand für den weniger profitablen Bereich der Technischen Dokumentation entsteht.
| |
| − | | |
| − | | |
| − | ==== Single Source Publishing/ Single Source Information ====
| |
| − | Single Source Publishing bedeutet, dass zur Ausgabe verschiedener Daten(-formate), z.B. für Web, Print, CD-ROM, auf die selben Daten zurückgegriffen wird. Es sollte möglichst für jede Art der Veröffentlichung festgelegt sein, wie die Informationen dargestellt werden sollen. Wenn sich in der Folge Änderungen im Layout ergeben, hat dies keinen Einfluss auf die Information des Dokuments. Da die Pflege der Information nun zentral vor sich gehen kann, spricht man hier von Single Source Information. Um diese beiden Punkte optimal umzusetzen, sind jedoch konzeptuelle Dokument- und Informationsschemata in Form von '''Document Type Definition''' (- DTD) und formale und inhaltlich logische Strukturierung durch '''Logical Markup''' vorausgesetzt.
| |
| − | | |
| − | | |
| − | | |
| − | | |
| − | | |
| − | === Quelle: ===
| |
| − | | |
| − | Jiri Panyr., Technische Redaktion, in: Kuhlen/Seeger/Strauch (Hrsg.): Grundlagen der praktischen Information und Dokumentation (2004), Kap C9, S. 461-467
| |
| − | | |
| − | | |
| − | === Links: ===
| |
| − | | |
| − | Der deutsche Fachverband für Technische Kommunikation und Informationsentwicklung:<br> http://www.tekom.de Artikel, Links und Downloads zum Thema technische Redaktion
| |
