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.