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”

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.

4 Kommentare

Kommentar hinterlassen

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