Technische Dokumentation

Technische Dokumentation

Wer ein technisches Produkt, sei es in Form von Hardware oder Software, erzeugt, kommt nicht umhin eine Technische Dokumentation zu erstellen. Und umgekehrt: Wer schon einmal technische Produkte komplexerer Art bedienen, reparieren, pflegen oder warten musste hat wahrscheinlich dazu eine Technische Dokumentation zu Rate gezogen.

Was ist Technische Dokumentation?

Etwas allgemeiner formuliert ist die Technische Dokumentation eine Teilmenge der Dokumentation und umfasst alle Informationsprodukte, welche ein technisches Produkt unter Ber√ľcksichtigung einer bestimmten Zielgruppe beschreiben.

Unter Informationsprodukte versteht man hierbei alle Medien, die geeignet sind Informationen zu vermitteln. Das können also sein ein Handbuch in Papier oder als PDF, Dateien auf einer CD-Rom oder zum Download oder aber auch Videos und eher weniger verbreitet reine Audiodateien.

Zu den Technischen Produkten zählen sämtliche technischen Erzeugnisse, die in irgendeiner Art und Weise produziert oder hergestellt werden. Wie oben erwähnt, kann man grob von sämtlicher Hard- und Software sprechen. Es gehören aber auch alle technischen Produkte ohne elektrische/elektronische Bestandteile dazu, wie zum Beispiel eine mechanische Wasserpumpe oder ein konventionelles Fahrrad.

Dabei ist die Technische Dokumentation immer auf eine gewisse Zeilgruppe ausgerichtet und m√∂chte passend f√ľr die jeweilige Zielgruppe Produktinformationen und Anleitungen bereitstellen, die zum Beispiel f√ľr Reparaturen oder Bedienungen anleiten oder ein tieferes Verst√§ndnis vom Produkt f√ľr dessen Weiterentwicklung vermitteln.

Anwendungsfälle Technischer Dokumentation

So allgemein der Begriff Technische Dokumentation aus ist, so vielfältig sind deren Anwendungsfälle. Zu den Technischen Dokumentationen zählen unter anderem:

  • Bedienungsanleitungen
  • Montageanleitungen
  • Reparaturanleitungen
  • Installationsanleitungen
  • elektrische, elektronische, pneumatische, hydraulische Schaltpl√§ne und Schaltungsb√ľcher
  • Stromlaufpl√§ne
  • Hilfe-Dateien f√ľr Software(-bedienung) zum Beispiel in Form von *.chm-Dateien
  • Video-Tutorials bzw.. Tutorials allgemein
  • Produkthandb√ľcher
  • Produkt-Datenbl√§tter
  • Wartungsbedingungen und -anweisungen
  • Online-Hilfen

Aus den verschiedenen Begrifflichkeiten wird ersichtlich, dass eine Technische Dokumentation immer auf einen bestimmten Personenkreis zugeschnitten ist.

Der Softwareprogrammierer wird auf die interne Quellcode- und Softwarearchitektur-Dokumentation zur√ľckgreifen w√§hrend der Softwareanwender sich die Online-Hilfen reinzieht oder die CHM-Datei studiert.

Der KfZ-Mechatroniker wird bei der Reparatur der Einspritzung auf die Reparaturanleitungen des KfZ-Herstellers zur√ľckgreifen und der Elektriker der √Ąnderungen an einem Steuerschrank vornimmt, wird den Stromlaufplan als Basis nehmen.

Aus diesem Grund ist beim Erstellen der Dokumentation darauf zu achten, dass alle relevanten Informationen in verst√§ndlicher und gut strukturierter Art und Weise hervorgehen. Die Darstellung und Pr√§sentation der Informationen muss auf den jeweiligen Anwendungszweck zugeschnitten sein. Ein oft herangezogenes Beispiel aus dem privaten Alltag f√ľr √§rgerliche und schlechte Dokumentation sind Aufbauanleitungen von M√∂beln einschl√§giger schwedischer Firmen.

Externe und interne Technische Dokumentation

Die Technische Dokumentation wird unterschieden in externe und interne Dokumentation.

Externe Technische Dokumentation

Die externe Dokumentation richtet sich an alle Anwender und Betreiber des technischen Erzeugnisses. Damit soll sichergestellt werden, dass das Produkt bestimmungsgem√§√ü in Betrieb genommen wird, bestimmungsgem√§√ü betrieben und gewartet wird und auch bestimmungsgem√§√ü au√üer Betrieb genommen wird bis hin zur fachgerechten Entsorgung. Dazu z√§hlen im Allgemeinen Bedienungshandb√ľcher, Aufbauanleitungen, Pflege- und Wartungsanweisungen, Datenbl√§tter zu den zu ber√ľcksichtigenden Umgebungsbedingungen (Temperatur, Feuchte, EMV), Online-Hilfen, Tutorials, Betriebsanleitungen. Die externe technische Dokumentation wird meistens von den Technischen Redakteuren der produzierenden Firma erstellt. Die zu verwendenden Sprachen richten sich dabei u.a. nach den zu bedienenden M√§rkten.

Der Produzent von technischen Produkten ist aufgrund des Ger√§te- und Produktsicherheitsgesetzt im Wesentlichen sogar dazu verpflichtet eine externe technische Dokumentation bereitzustellen. Denn nur so kann er sicherstellen bzw. sich selbst absichern, dass das Erzeugnis bestimmungsgem√§√ü benutzt und betrieben wird und keine Gefahr f√ľr den Anwender ausgeht. Die Benutzung des F√∂ns in der Badewanne ist vermutlich kein bestimmungsgem√§√üer Betrieb.

Interne Dokumentation

Die interne technische Dokumentation dient der Aufbewahrung aller f√ľr das Erzeugnis relevanten Informationen. Dazu z√§hlen alle Spezifikationen, Berechnungen, Pflichtenhefte, Auslegungsgrundlagen und -annahmen, Risikobetrachtungen und Risikoanalyse (HAZOP), Schaltpl√§ne, Stromlaufpl√§ne, Technischen Zeichnungen, Materiallisten, Fertigungsunterlagen, Produkttests, etc. Die interne technische Dokumentation deckt den gesamten Produktlebenszyklus von der ersten Planung bis zur fachgerechten Entsorgung ab.

Die gut organisierte Archivierung der internen technischen Dokumentation ist aus mindestens zweierlei Gr√ľnden von gro√üer Bedeutung. Zum einen kann der Produkthersteller damit seiner Nachweispflicht gegen√ľber Beh√∂rden, Gerichten und Zentralen √úberwachungsstellen (Z√úS/T√úV) nachkommen. Zum anderen ben√∂tigt der Produkthersteller die Technische Dokumentation aus Eigeninteresse. Denn nur so ist es Ihm m√∂glich, sein Produkt und die dahinter stehende Fertigung aufrechtzuerhalten, weiterzuentwickeln, Produktfehler zu beheben und neue Mitarbeiter einzuarbeiten.

Gesetzliche Regelungen und Normen Technischer Dokumentation

Gesetzliche Regelungen

Da von vielen Produkten bei fehlerhafter Anwendung oder Anwendung unter nicht zul√§ssigen Rahmenbedingungen eine Gefahr ausgehen kann, wird die Technische Dokumentation von vielen nationalen und europ√§ischen Gesetzen und Verordnungen gefordert. An oberster Stelle sei hier das Ger√§te- und Produktsicherheitsgesetz (GPSG) und dessen EG-Richtlinien genannt. Die EG-Richtlinien werden von den zugeh√∂rige Verordnungen in nationales Recht umgesetzt, wie zum Beispiel die Druckger√§teverordnung (14. ProdSV), die Explosionsschutzverordnung/ATEX (11. ProdSV), Maschinenrichtlinie (9. ProdSV) und die Niederspannungsrichtlinie bzw. Verordnung √ľber elektrische Betriebsmittel (1. ProdSV), um nur einige zu nennen. Es ist also entsprechend des Anwendungsfall die jeweilige Verordnung zu ber√ľcksichtigen, wobei auch mehre Verordnungen gleichzeitig zu ber√ľcksichtigen sein k√∂nnen.

Kommt es zu einem Schadensfall, der auf eine fehlerhafte externe Technische Dokumentation zur√ľckzuf√ľhren ist, so tritt der Produkthersteller in Haftung. √úber einen Haftungsanspruch werden ebenfalls Gerichte entscheiden, wenn es zu einem Schadensfall kommt, welcher auf einen Ger√§tefehler, zum Beispiel Konstruktionsfehler, zur√ľckzuf√ľhren ist und sich dieser √ľber die interne technische Dokumentation nachweisen l√§sst oder eine fehlende oder mangelhafte Risikoanalyse vorliegt.

Normen und Richtlinien

Weitere Forderungen zur Technischen Dokumentation kommen dann aus vielen Normen (DIN, EN, ISO) sowie Richtlinien (z.B. VDI, NAMUR) oder branchenspezifischen Verbandsrichtlinien (z.B. VGB, ZVEI).

Normen und Richtlinien die sich direkt oder ausschließlich mit der Technischen Dokumentation befassen sind unter anderem:

    • Europ√§ische Norm EN 82079-1: “Erstellen von Gebrauchsanleitungen – Gliederung, Inhalt und Darstellung – Teil 1: Allgemeine Grunds√§tze und ausf√ľhrliche Anforderungen”
    • VDI 4500 “Technische Dokumentation” (6 Bl√§tter)
    • DIN EN 61355 “Klassifikation und Kennzeichnung von Dokumenten f√ľr Anlagen, Systeme und Ausr√ľstungen”
    • DIN 6789:2013-10 “Dokumentationssystematik – Verf√§lschungssicherheit und Qualit√§tskriterien f√ľr die Freigabe digitaler Produktdaten”
    • VGB S-831 “Lieferung der Technischen Dokumentation (Technische Anlagendaten, Dokumente) f√ľr Anlagen der Energieversorgung”
    • ISO 15787 “Technische Produktdokumentation – W√§rmebehandelte Teile aus Eisenwerkstoffen – Darstellung und Angaben”
    • ISO 3098 “Technische Produktdokumentation – Schriften – Teil 1: Grundregeln”
    • ISO 10209 “Technische Produktdokumentation – Vokabular – Begriffe f√ľr technische Zeichnungen, Produktdefinition und verwandte Dokumentation”
    • ISO 2162 “Technische Produktdokumentation – Federn – Teil 1: Vereinfachte Darstellung”
    • ISO 5457 “Technische Produktdokumentation – Formate und Gestaltung von Zeichnungsvordrucken”

Hier muss sich jeder Technische Redakteur im Vorfeld erkundigen, welche branchenspezifischen Normen und Verbandsempfehlungen es zu ber√ľcksichtigen gilt. Ggf. werden von einem Auftraggeber auch die Einhaltung bestimmter Normen und Richtlinien im Lastenheft gefordert.

Technische Dokumentation erstellen

Strukturierung der Technischen Dokumentation

Bezogen auf die jeweilige Zielgruppe muss die Dokumentation verständlich sein und benötigte Inhalte schnell auffindbar und erfassbar sein. Das setzt eine gute inhaltliche Strukturierung der Technischen Dokumentation voraus. Je nach Schwerpunkt der Dokumentation ergeben sich unterschiedliche Anforderungen an die Gliederung. Eine Möbelaufbau-Anleitung wird wohl im Wesentlichen aus Bildern bestehen, die die Vorgehensweise detailliert visualisieren. Komplexere Technische Dokumentation zum Beispiel zu einer Risiko- oder Gefährdungsanalyse wird erst einmal eine Begriffsdefinition voranstellen. Folgende Elemente können oder sollten Bestandteil einer Technischen Dokumentation sein:

  • Revisions-/Versionsblatt mit √Ąnderungshistorie
  • Inhaltsverzeichnis
  • Begriffskl√§rungen/Glossar
  • Geltungsbereich/Zielgruppen
  • Rahmenbedingungen/Umgebungsbedingungen
  • beschreibender Teil (die eigentlichen technischen Inhalte; k√∂nnen auch technische Zeichnungen und Pl√§ne sein)
  • ggf. Listen (St√ľcklisten, Materiallisten)

Revisionierung und Versionierung von Technischer Dokumentation

Nachtr√§gliche √Ąnderungen und Fortschreibungen in einer Technischen Dokumentation m√ľssen eindeutig nachvollziehbar sein. Das hei√üt, dass man √Ąnderungen entsprechend kenntlich machen sollte, zum Beispiel neue Inhalte hervorhebt durch einen Strich in der Seitenleiste oder entfallene Inhalte als Durchgestrichen formatiert. M√∂glich sind auch separate √Ąnderungsbl√§tter (√Ąnderungshistorie), die alle √Ąnderungen zur Vorg√§ngerversion zusammenfassen. Nicht immer ist es sinnvoll eine riesige √Ąnderungshistorie mitzuf√ľhren, insbesondere wenn es um die externe technische Dokumentation geht. Bei Anleitungen k√∂nnen solche √Ąnderungsvermerke eher den Lesefluss und der Inhaltserfassung st√∂ren. Hier empfiehlt es sich zumindest in der internen Dokumentation die √Ąnderungen noch mal aufzubewahren.

Jede neue Revision/Version eines Dokuments sollte mit einer entsprechenden Nummer oder Buchstabenkennung versehen werden, welche hochgez√§hlt werden mit jedem neuen Stand. Au√üerdem sollte immer auch das Publikationsdatum angef√ľhrt werden. So l√§sst sich ein eindeutiger Bezug zu dem Dokument herstellen. Arbeiten mehrere Mitarbeiter oder Firmen an einem Dokument, sollte mindestens intern vermerkt werden, wer welche √Ąnderung vorgenommen hat und ggf. auf wessen Veranlassung oder aus welchem Grund die √Ąnderungen vorgenommen worden sind.

Unter Ber√ľcksichtigung der Qualit√§tssicherung, z.B. ISO 9001, oder gerichtsfester Nachvollziehbarkeit, sollten die einzelnen Revisionen/Versionen auch mehr oder weniger f√§lschungssicher gemacht werden (Daten-Integrit√§t). In der guten alten Papierwelt hat man daf√ľr oft Unterschriftenbl√§tter verwendet mit Gegenzeichnungen f√ľr “Erstellt“, “Gepr√ľft” und “Freigegeben“. Das zugeh√∂rige Papierexemplar wurde dann entsprechend sicher zum Beispiel in einem Firmenarchiv verwahrt.

Heutzutage besteht die Technische Dokumentation meistens nur noch aus digitalen Produkten, wie CAD-Zeichnungen, Word-Dateien, etc. Hier bestehen andere Anforderungen an die Datenintegrit√§t sowie an Digitalen Signaturen. Hier√ľber informiert die DIN 6789.

Software f√ľr Technische Dokumentation

In vielen Firmen wird es wohl Usus sein Produkte von Microsoft Office, sprich MS Word, einzusetzen, um die Technische Dokumentation zu erstellen. Als oft genannter Hauptgrund wird die gute Austauschbarkeit der Dateien angef√ľhrt, wenn man √ľber mehrere Abteilungen oder Firmen hinweg an einem Dokument arbeitet. Auch dass die meisten Bearbeiter im Umgang mit MS-Word fit sind, ist ein wesentlicher Grund. Professionelle Technische Redakteure greifen dann doch oft auf spezielle Autorenwerkzeuge (Help Authoring Tools), wie u.a. dem DA-HelpCreator, zur√ľck. Diese sind angepasst auf die Anforderungen f√ľr die Erstellung einer Online-Hilfe oder eben einer Technischen Dokumentation. Wichtig ist, dass ein schnelles Arbeiten m√∂glich ist, in dem zum Beispiel gewohnte Editoren mit Ablenkungsfreien Modus angeboten werden oder spezielle Editoren (z.B. Markdown-Editor), die schnelles Schreiben und Formatieren gleichzeitig unterst√ľtzen und Autovervollst√§ndigen-Funktionen bieten. Der Import von Bildern und anderen Medien sollte schnell von der Hand gehen durch einfache Drag&Drop-Mechanismen. Der wichtigste Punkt ist aber, dass man seine Technische Dokumentation in vielen Formate exportieren kann, damit man diese in verschiedener Form bereitstellen kann:

  • PDF-Export f√ľr Download oder Verteilung als Datei oder zum Drucken
  • HTML-Export f√ľrs Internet oder Intranet direkt auf den Server
  • CHM-Datei zum Einbinden einer Hilfe in einer Software

Dar√ľber hinaus sollte die Software f√ľr die Technische Dokumentation ein gutes Content Management beinhalten (CMS). Das hei√üt, dass einzelne Beitr√§ge gut und √ľbersichtlich in Kapiteln und Kategorien strukturiert werden k√∂nnen, Inhaltsverzeichnisse und Register automatisch erzeugt werden und Erg√§nzungen schnell und nachvollziehbar hinzugef√ľgt werden k√∂nnen, um der oben genannten Revisionierung und Versionierung gerecht zu werden.

5 Kommentare

Kommentar hinterlassen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.