|
|
Technical Documentation
|
|
|
|
|
Please note: This page is available in German language only.
Sorry for the inconvenience!
|
|
|
|
|
Was ist Technische Dokumentation?
|
|
|
Technische Dokumentation umfasst den gesamten Bereich von Dokumentationsaufgaben,
die zur Beschreibung eines technischen Produkts notwendig sind.
|
|
|
Zunächst kann man zwei Tätigkeitsbereiche unterscheiden: Die inhaltlichen
Arbeiten, bei denen das vorliegende Informationsmaterial zusammengetragen und
aufbereitet wird, und die technischen Arbeiten, also die Pflege der Dokumente,
deren Layout und in zunehmendem Maße auch die Handhabung von Datenbanken und
die Programmierung von XML-Codes.
|
|
|
Der Technische Redakteur
|
|
|
Seine Arbeit ist es, das Material für ein technisches Dokument, also z. B.
für eine Bedienungsanleitung, von den Informationsgebern zu beschaffen,
auszuwerten und aus Sicht des Lesers verständlich darzustellen. Das ist keine
leichte Aufgabe, denn in der Regel sprechen Ingenieure und Techniker eine
völlig andere Sprache als die Anwender eines technischen Gerätes –
angefüllt mit Fachausdrücken und Jargonfloskeln, die für den
Durchschnittsmenschen absolut unverständlich sind. Zudem verwenden sie
keine einheitlichen durchgängigen Bezeichnungen für dieselben Dinge.
Der Redakteur muss also für eine klar verständliche und vor allem
unmissverständliche Terminologie sorgen und diese im gesamten Dokument,
möglicherweise sogar in allen vergleichbaren Dokumenten konsistent halten.
Darüber hinaus müssen Sprachniveau und Sprachgebung einheitlich gehalten
werden, damit der Anwender sich gut „angeleitet“ fühlt.
Selbstverständlich wird auch ein korrekter Sprachstil, Beherrschung der
Grammatik und eine sichere Rechtschreibung erwartet.
|
|
|
Der Layouter und seine Werkzeuge
|
|
|
|
Früher, als noch Bleilettern Verwendung fanden, nannte man ihn
„Schriftsetzer“; heute arbeitet der Layouter mit dem Computer und
beherrscht sein Satzprogramm. Idealerweise unterstützt ihn dieses bei den
Formatierungsarbeiten, damit er sich auf den Inhalt konzentrieren kann, aber
leider gibt es viele Eigenarten, bei denen der Layouter eher mit dem Satzprogramm
kämpfen muss.
|
|
Nicht jedes Programm ist für Technische Dokumente geeignet. Microsoft Word hat den Vorteil, weit verbreitet und
vergleichsweise preiswert zu sein, und es gibt Technische Redaktionsabteilungen,
die wirklich damit ihre Dokumente pflegen. Ich bestreite nicht, dass dies ein
gangbarer Weg ist, aber ein einfacher Weg ist es bestimmt nicht.
|
|
Für Technische Dokumentation weitaus besser geeignet ist Adobe FrameMaker. Das Programm ist speziell auf
die Bedürfnisse dieser Aufgabenstellung zugeschnitten: Es kann große
Mengen Text und Bilder zuverlässig aufnehmen und übersichtlich
darstellen, und es bietet viele Möglichkeiten zur rationellen Bearbeitung.
|
|
Ein zeitgemäßeres Programm ist Adobe
InDesign. Hiermit ist eine noch kreativere Gestaltung möglich,
und doch ist es dieser Software bisher nicht gelungen, dem FrameMaker den Rang abzulaufen. Das liegt einerseits
an hohen Investitionskosten für die Umstellung, andererseits ist der Bedarf
für umfassende Schulung und Einarbeitung gegeben. Zudem sind nicht alle
Funktionen so handlich anzuwenden. Damit ist das Programm eher für die
Bearbeitung von grafisch anspruchsvoll gestalteten Broschüren geeignet als
für dicke Anleitungsbücher.
|
|
Es gibt natürlich noch einige weitere Programme, wie Interleaf oder PageMaker, aber diese sind heute nur noch selten in
Gebrauch. Trotzdem schätze ich am PageMaker seine unerreichte Handlichkeit gerade
für schnell zu erstellende Dokumente wie Faltblätter oder kleine
Broschüren.
|
|
Ein noch relativ junges Verfahren ist das Content Management
System. Hier dient der Texteditor zur Eingabe und Bearbeitung des
Textinhalts und zur Auswahl der Formatierungen. Alle Texte und Bilder werden als
Bausteine in einer großen Datenbank gespeichert, und das Zieldokument wird
„auf Knopfdruck“ nach vorgegebenen Layoutanweisungen zusammengestellt.
Lediglich das Endlayout erfolgt dann wieder in einem der genannten Satzprogramme.
|
|
|
Das Technische Dokument
|
|
Um Ihnen eine Vorstellung von der Vielfalt Technischer Dokumente zu geben, habe ich
hier einmal alle für den Lebenszyklus eines technischen Produkts unmittelbar
und mittelbar relevanten Dokumentarten aufgeführt.
|
|
|
Vorbereitung: Designstudie, Beschreibung des
Prototyps
|
|
|
|
Entwicklung: Lastenheft, Pflichtenheft,
Spezifikation, Dokumentation für Software und Hardware, firmeninterne
Know-How-Datensammlung
|
|
|
|
Fertigung: Fertigungsunterlagen, firmeninterne
Handlungsanweisungen
|
|
|
|
Qualitätssicherung: Beschaffungsvorgaben,
Abnahmekriterien, Werksnormen
|
|
|
|
Vertrieb: Präsentation, Datenblatt,
Broschüre, Katalog, Internet-Produktbeschreibung, Zertifikate, Zulassungen
|
|
|
|
Anwender: Aufbauanleitung, Bedienungsanleitung
in kurzer und ausführlicher Form, Online- oder Offline-Hilfe,
Schritt-für-Schritt-Anleitung (Tutorial), Praktische Anwendungsempfehlungen
(How-To-Anleitung)
|
|
|
|
Reparatur: Wartungsplan, Serviceanleitung,
Ersatzteileliste
|
|
|
Nicht alle genannten Dokumentarten erfordern die Bearbeitung in einer Technischen
Redaktion, aber ihre Bereitstellung und Pflege ist für die Herstellung
technischer Produkte unerlässlich.
|
|
|
Die umfassende Dienstleistung
|
|
Alle hier beschriebenen Tätigkeiten kann ich als Dienstleistung anbieten:
die redaktionelle Betreuung der jeweiligen Dokumentationsaufgabe ebenso wie die
Handhabung des Dokuments im Satzprogramm bis hin zum Endlayout. In jedem der
Bereiche kann ich langjährige Erfahrung vorweisen. Eine Übersicht
über mein gesamtes Leistungsangebot können Sie hier finden.
|
|
Haben Sie Fragen? Schreiben Sie mir eine E-Mail oder rufen Sie
mich an: +49 911 80 82 56 .
|
|
|
Referenzen
|
|
|
|
Bearbeitung von Handbüchern mit Adobe FrameMaker und Microsoft Word im
Rahmen einer Anstellung als Technischer Redakteur bei Ziehm Imaging in Nürnberg und Mohles in Erlangen
|
|
|
|
Erstellung von Handbüchern und Online-Hilfen mit Microsoft Word und
WexTech Doc-To-Help für Engel EDV-Systeme in Nürnberg
|
|
|
|
Layout von Broschüren und Faltblättern mit Adobe PageMaker für
den Bund Naturschutz Kreisgruppe Nürnberg
|
|
|
|
|
|
Good engineering deserves best documentation
|
|
engage Heuss !
|
|
|
|
