Transcom-Logo. Transcom bietet Technische Dokumentation und technische Kommunikation
 
» Home  > Wir über uns  > Leistungen  > Technische Dokumentation English  Deutsch

Was ist "Technische Dokumentation"?

"Technische Dokumentation" ist der allgemeine Oberbegriff für die Dokumentation zu einem Produkt. Zumeist wird dabei in erster Linie an die Unterlagen und Dokumente gedacht, die die Herstellerfirma nach außen gibt:

  • Bedienungsanleitungen
  • Betriebsanleitungen
  • Serviceanleitungen
  • Installationshandbücher
  • Softwarehandbücher
  • (Link intern) Online-Hilfen

Die (Link extern) tekom, der "deutsche Fachverband für Technische Kommunikation und Informationsentwicklung" propagiert eine weiter gefasste Definition:

Der Begriff 'technische Dokumentation' umfaßt verschiedene Dokumente mit produktbezogenen Daten und Informationen, die für verschiedene Zwecke verwendet und gespeichert werden. Unter verschiedenen Zwecken ist zu verstehen: Produktdefinition und Produktspezifikation, Konstruktion, Herstellung, Qualitätssicherung, Produkthaftung, Produktdarstellung, Beschreibung von Funktionen und Schnittstellen, bestimmungsgemäße, sichere und korrekte Anwendung, Instandhaltung und Reparatur eines technischen Produkts sowie gefahrlose Entsorgung.

Diese weite Sicht, bei der alle Dokumente, die im Produktlebenszyklus zum Produkt entstehen, als Teil der technischen Dokumentation gesehen werden, ist durchaus berechtigt. Schließlich geht es darum, technisches Know-how und produkt-historische Informationen für nachfolgende Nutzer der Informationen (seien es Entwickler oder Anwender, Patentanwälte oder Staatsanwälte mit Schwerpunkt Produkthaftung) verfügbar zu machen.

Der Schwerpunkt für Dienstleister der technischen Dokumentation liegt jedoch meist bei den Dokumenten, die nach der Produktion der Produkte benötigt werden — von Verkäufern, Systemintegratoren, Installateuren, Bedienern, Servicemitarbeitern, Entsorgungsunternehmen etc. Die Gründe sind einfach:

  • An die Dokumente werden hohe Anforderungen hinsichtlich Verständlichkeit (bezogen auf die Mitglieder der jeweiligen Zielgruppe), optischer Aufmachung, Einhaltung von Normen/Richtlinien/Gesetzen, sprachlicher Korrektheit etc. gestellt.
  • Die Dokumente gehen an die Öffentlichkeit, sind also Teil der Außenpräsentation des Herstellers.
  • Für die Erarbeitung der Dokumente ist nur relativ wenig herstellerspezifisches Wissen und Know-how erforderlich, insbesondere auch keine Unternehmensgeheimnisse. Statt dessen ist viel Erfahrung mit den Werkzeugen und Zielmedien notwendig, was bei Online-Publikation als Hilfesystem (WinHelp, HTMLHelp, JavaHelp oder "einfach" DHTML-Help) besonders augenfällig wird.

Diese sich aus den obigen Gründen ergebende Kombination an notwendigem Grundlagenwissen, Erfahrung hinsichtlich der Erfüllung der Anforderungen und dokumentationsspezifischem Fachwissen findet sich bei einer spezifischen Berufsgruppe: Den technischen Redakteuren. Sie sind innerbetrieblich oder beim Dienstleister die Mittler zwischen Hersteller/Entwickler und Einkaufsentscheider/Anwender.

Übrigens: Bei Transcom bevorzugen wir statt 'technische Dokumentation' oftmals den allgemeineren Begriff "(Link intern) 'technische Kommunikation'", weil dieser den Umfang unserer Leistungen besser einfängt.

Anleitung versus Anweisung versus Handbuch versus …

Es gibt immer wieder eine Konfusion darüber, ob es Bedienungsanleitung, Bedienungshandbuch, Betriebshandbuch, Betriebsanweisung oder gar Bedienungsanweisung etc. pp. heißen soll. Auch die Normen für technische Redakteure und die Gesetze sind sich da nicht einig, verwenden sehr unterschiedliche Begriffe. Versuchen wir mal ein wenig zu ordnen — nach sprachlichen Gesichtspunkten:

  • "Anweisung" kommt von "anweisen": Anweisen kann nur der Vorgesetzte den Untergebenen, also der Chef den Mitarbeiter (oder auch die Eltern ihr Kind). Eine Betriebsanweisung kann daher nur innerbetrieblich erfolgen. Dementsprechend ist die Betriebsanweisung jenes Dokument, das für einen spezifischen Arbeitsplatz innerhalb eines Unternehmens festschreibt, wie die Arbeitsabläufe aussehen sollen. Sie berücksichtigt die speziellen Bedürfnisse und Anforderungen innerhalb des Unternehmens. Damit ist klar, dass eine Betriebsanweisung nicht vom Hersteller eines Produkts dem Produkt mitgeliefert werden kann — dieser kennt die Firmeninterna beim Anwender nämlich gar nicht.
  • "Anleitung" kommt von "anleiten": Jemand, der schon etwas kann, leitet jemand anderen an, der es noch nicht kann. Hier begegnen sich zwei auf gleicher Augenhöhe, zum Beispiel Hersteller und Anwender. Die Anleitung ist damit jenes Dokument, das den Umgang mit einem Produkt vermittelt. Beim "Anleiten" wird allerdings praktisch keine Theorie mehr vermittelt, das heißt, die Beschreibung des Produkts ist nicht Teil der Anleitung. Dabei ist das Wort "Anleitung" medienneutral, sagt also nichts darüber aus, in welcher Form die Anleitung publiziert wird (Papier oder Online).
  • "Bedienungsanleitung" oder "Bedienungshandbuch": Das erste Wort in den Komposita sagt es schon — es geht um die Bedienung. Das Bedienungshandbuch ist also das Buch, in dem die Bedienung beschrieben ist. Damit ist das Publikationsmedium benannt. Der Begriff "Bedienungsanleitung" hingegen ist medienneutral.
  • Betriebsanleitung/Betriebshandbuch: Auch hier ist es wieder das erste Wort in den Komposita — es geht allgemein um den Betrieb. Dieser ist allumfassender als die Bedienung, fängt eigentlich bei Transport und Lagerung an, geht über die Installation/Aufstellung und Inbetriebnahme zur Bedienung, setzt sich dann mit Reinigung, Wartung und Service bzw. Reparatur fort, um schließlich am Ende des Produktlebenszyklus mit Demontage und Entsorgung zu enden. Ein Dokument, das den Betrieb beschreibt, sollte also entsprechend umfassend sein (nicht zu vergessen die zusammengefassten Sicherheitshinweise).

Natürlich kann die Betriebsanleitung auch in ihre Einzelteile zerlegt werden, also je ein Dokument zu Transport/Lagerung, Installation, etc. Auch kann die Aufteilung nach Anwenderrollen (Zielgruppe) erfolgen: Systemintegrator, Bediener/Anwender, Administrator, Servicetechniker usw. All diese Unterscheidungen orientieren sich jeweils am Inhalt des jeweiligen Dokuments. Unbestimmt bleibt die Form, das Medium, in dem das Dokument publiziert wird.

Publikationsmedien

Technische Dokumentation ist nicht an ein spezifische Publikationsmedium gebunden. Es kann auf Papier (gebundenes Buch, Mappe mit Ringbindung, geheftete Broschüre, Ordner mit Ringmechanik, Schnellhefter etc.) ebenso verteilt werden, wie als PDF-Datei, Online-Hilfe, Website oder ähnlichem auf CD oder im Internet.

Da heute die technische Dokumentation vielfach in verschiedenen Medien parallel publiziert wird (als Buch/Broschüre dem Produkt beigelegt und als PDF-Datei oder Satz von Webseiten im Internet abrufbar), ist es sinnvoll, für die Dokumente eine medienneutrale Bezeichnung zu wählen.

PostScript(um)

Ihnen kommt dieser Text selbtsam vor? Erinnern Sie sich noch? — In der Schule erhielten Sie gelegentlich die Aufgabe, einen Aufsatz zu schreiben, in dem alle Wörter aus einer vorgegebenen Liste enthalten sind. Das Ergebnis? Nun, vermutlich haben Sie schon lange nicht mehr dran gedacht.

Diese Seite ist nach demselben Prinzip entstanden, nur dass heute die Suchmaschinen und die per Suchmaschine suchenden Surfer die Aufgabe stellen: Egal, welche Kombination an Suchwörtern, die für die technische Dokumentation relevant sind, die Surfer eingeben — die Suchmaschinen sollen immer wenigstens diese Seite aus unserem Angebot listen können. Dafür sind die übrigen Seiten themengerichteter.

» Transcom gehört zum Verbund der media offices