VDI 4500 – Technische Dokumentation

In voran gegangenen Beiträgen wurde bereits auf das Thema Technische Dokumentation und zu berĂĽcksichtigenden Normen, Richtlinien und Gesetzgebungen eingegangen. Der VDI stellt in 6 verschiedenen Blättern eine weitere Richtlinie bereit, die jeder Technische Redakteur kennen und nach Möglichkeit auch berĂĽcksichtigen sollte. In den einzelnen Teilen bzw. Blättern, wie der VDI sie nennt, wird das Thema “Technische Dokumentation” rundum beleuchtet: Von der Verwaltung und Organisation, ĂĽber die Planung, Erstellung und Gestaltung bis hin zur Publikation wird hier vom VDI ein Leitfaden an die Hand gegeben.

Das Blatt 5 der VDI 4500 ist zum Zeitpunkt der Verfassung diese Artikel jedoch noch in Planung mit dem voraussichtlichen Erscheinungsdatum 12/2021. Andere Blätter sind in Überarbeitung. Genaue Informationen dazu, sowie Preise und Bestellmöglichkeiten findet man auf der zugehörigen Seite des VDI.

Auch wenn es ein deutscher Verein ist, werden die VDI-Richtlinien in den meisten Fällen zweisprachig, in Deutsch und Englisch innerhalb eines Dokuments bereitgestellt. In wie weit die VDI-Richtlinien eine Relevanz bei ausländischen Projekten haben ist dem Verfasser nicht bekannt. Man kann aber davon ausgehen, dass die VDI 4500 ebenfalls eine gute “Anlegekante” fĂĽr die fremdsprachige Technische Dokumentation darstellt.

VDI 4500 Blatt 1

Dieses Blatt befasst sich mit der Begriffsdefinitionen und den rechtliche Grundlagen. Darin werden die Begriffe und Grundlagen geklärt auf welche alle weiteren Blätter aufbauen. Es beinhaltet somit eine grundlegende Einführung, klärt aber, was eine Interne und Externe Technische Dokumentation ist, was ein Produktlebenszyklus ist sowie welche Rechtsbereiche/Rechtsvorschriften zu beachten sind.

Weitere Informationen

VDI 4500 Blatt 2

Dieses Blatt befasst sich mit dem Organisieren und Verwalten der Technischen Dokumentation. Dieses Blatt zielt auf die Organisation der firmeninternen Prozesse, die im Zusammenhang mit der Erstellung und Veröffentlichung der Technischen Dokumentation stehen, ab. Ein Richtlinie kann immer nur allgemeine Ansätze oder in diesem Fall Prozesse beschreiben. Aus diesem Grund sind die Erkenntnisse dieses Blattes auf die jeweilige eigene Firmen- und/oder Projektsituation zu adaptieren. Es werden also Organisationsaufgaben und -verantwortlichkeiten beschrieben, organisatorische Voraussetzungen, zum Beispiel in Form eines Redaktionshandbuchs, sowie Qualifikationsanforderungen an die Technischen Redakteure. Darüber hinaus werden Anforderungen an die Organisation und Verwaltung von Dokumenten in Form eines Dokumentenmanagements beschrieben.

Weitere Informationen

VDI 4500 Blatt 3

Dieses Blatt befasst sich mit dem Erstellen und Verteilen von elektronischen Ersatzteilinformationen. Es beschreibt die Anforderungen für die Bereitstellung eines elektronischen Ersatzteilkatalogs (eETK) inkl. der Schnittstellen zwischen Kunden, Lieferanten und Herstellern. Hierfür wird der Datenaustausch sowie zugehörige Austauschformate beschrieben.

Weitere Informationen

VDI 4500 Blatt 4

Dieses Blatt befasst sich mit dem Dokumentationsprozess; sprich dem Planen, Erstellen und Gestalten. Beim Planen der Technischen Dokumentation geht es darum die Dokumentenarten zu bestimmen und die Input-Daten der Dokumentation zu erfassen. Die Gestaltung befasst sich mit dem Layout, Farb-, Grafik- und Textverwendung sowie mit den Ausgabemedien. Darüber hinaus soll eine Beschreibung zum Qualtitätsmanagement helfen, Schwachstellen in der Dokumentation aufzudecken, den Bezug zum Produkt herzustellen und eine generelle Akzeptanz und Verständlichkeit zu gewährleisten.

Weitere Informationen

VDI 4500 Blatt 5

Dieses Blatt will sich mit dem wirtschaftlichen Dokumentieren befassen.
Stand 2020 befindet sich dieses Blatt noch in Planung und wird voraussichtlich in 12/2021 veröffentlicht. Ziel ist es wirtschaftliche Grundlagen für den Dokumentationsprozess in den einzelnen Phasen des Produktlebenszyklus an die Hand zu geben, so dass eine wirtschaftliche Bewertung möglich wird.

Weitere Informationen

VDI 4500 Blatt 6

Dieses Blatt befasst sich mit dem Dokumentationsprozess – Publizieren. Damit richtet sich dieses Blatt an alle Personenkreise, die mit der technischen Umsetzung der Publikation betraut sind. Es wird auf die Verwendung von EDV-Werkzeugen fĂĽr die Erstellung und Veröffentlichung unter BerĂĽcksichtigung der verschiedenen Publikationskanäle (z.B. Druck, Internet) eingegangen. Die Veröffentlichung ĂĽber Freigabeprozedere, die Verwaltung von Versionsständen und die Archivierung, immer unter BerĂĽcksichtigung der rechtlichen Rahmenbedingungen, sind ebenfalls Bestandteil diese Blattes.

Weitere Informationen

Auch wenn der Begriff ggf. nicht Einzug in diese Richtlinienreihe hält, so können Autorenwerkzeuge, auch sogenannte Help Authoring Tools, wie der DA-HelpCreator ein probates Hilfsmittel sein, insbesondere wenn es darum geht die Dokumentation im Internet/Intranet bereitzustellen oder für eine Software oder Firmware die Dokumentation in Form einer Hilfe-Datei (*CHM-File) bereitzustellen.

 

Kommentar hinterlassen

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