VDI 4500 Blatt 2-2006 Technical documentation - Organization and management.pdf

1、VEREIN DEUTSCHERINGENIEURETechnische DokumentationOrganisieren und VerwaltenTechnical documentationOrganization and managementVDI 4500Blatt 2 / Part 2Ausg. deutsch/englischIssue German/EnglishVDI-Handbuch KonstruktionVDI-RICHTLINIENICS 01.110 November 2006Frhere Ausgabe: 09.05 Entwurf,deutschFormer

2、edition: 09/05 Draft, in German onlyDie deutsche Version dieser Richtlinie ist verbindlich. No guarantee can be given with respect to the English transla-tion. The German version of this guideline shall be taken asauthoritative.Zu beziehen durch / Available at Beuth VerlagGmbH, 10772 Berlin Alle Rec

3、hte vorbehalten / All rights reserved Verein Deutscher Ingenieure e.V., Dsseldorf 2006Vervielfltigung auchfr innerbetriebliche Zwecke nicht gestattet / Reproduction even for internal use not permittedVDI-Gesellschaft Entwicklung Konstruktion VertriebAusschuss Technische DokumentationInhalt Seite1 Ei

4、nfhrung . . . . . . . . . . . . . . . . . . . 21.1 Ihr Nutzen . . . . . . . . . . . . . . . . . . 41.2 Was gehrt zur Technischen Dokumentation? . . . . . . . . . . . . . . . 42 Organisationsverantwortung . . . . . . . . . 62.1 Organisatorische Voraussetzungen . . . . . 62.2 Verantwortung der Geschft

5、sleitung . . . . 102.3 Zentrale Organisationsaufgaben . . . . . . 102.4 Integration fr die Unternehmens-organisation . . . . . . . . . . . . . . . . . 123 Organisatorische Voraussetzungen. . . . . . 143.1 Prozessmanagement. . . . . . . . . . . . . 143.2 Redaktionshandbuch . . . . . . . . . . . . 163

6、.2.1 Ziele und Nutzen . . . . . . . . . . . 163.2.2 Beispiele . . . . . . . . . . . . . . . 18Vorschrift fr Gestaltung vonWarnhinweisen . . . . . . . . . . . . 18Gliederung eines Redaktions-handbuches . . . . . . . . . . . . . . 183.3 Qualifikation der Mitarbeiter . . . . . . . . 224 Dokumentenmanag

7、ement . . . . . . . . . . . 224.1 Was ist Dokumentenmanagement? . . . . . 224.2 Forderungen an das Dokumenten-management . . . . . . . . . . . . . . . . . 224.3 Dokumentenverwaltung . . . . . . . . . . . 244.3.1 Klassifizierung . . . . . . . . . . . . 244.3.2 Terminologie . . . . . . . . . . . . . 2

8、44.3.3 Dateiformate . . . . . . . . . . . . . 264.3.4 Dokumente pflegen . . . . . . . . . 284.3.5 Dokumente verteilen . . . . . . . . . 304.4 Daten und Dokumente sichern und archivieren . . . . . . . . . . . . . . . . . . 304.4.1 Forderungen an die Datensicherungund -archivierung. . . . . . . . . .

9、. 304.4.2 Sichern . . . . . . . . . . . . . . . . 324.4.3 Archivieren . . . . . . . . . . . . . . 344.5 Schnittstellen zu internen oder externen Dienstleistern . . . . . . . . . . . . . . . . 385 Fazit. . . . . . . . . . . . . . . . . . . . . . . . 406Index . . . . . . . . . . . . . . . . . . . . .

10、. . 42Schrifttum . . . . . . . . . . . . . . . . . . . . . . 46Contents Page1 Introduction . . . . . . . . . . . . . . . . . . . 31.1 Your benefit. . . . . . . . . . . . . . . . . . 51.2 What belongs to technicaldocumentation?. . . . . . . . . . . . . . . . 52 Organization responsibility . . . . . .

11、 . . . . . 72.1 Organizational conditions . . . . . . . . . . 72.2 Responsibility of the management. . . . . . 112.3 Central organizational tasks . . . . . . . . . 112.4 Integration into the enterprise organization. . . . . . . . . . . . . . . . . . . . . . . . 133 Organizational conditions. . . . .

12、 . . . . . . . 153.1 Process management . . . . . . . . . . . . . 153.2 Editorship manual . . . . . . . . . . . . . . 173.2.1 Aims and benefit . . . . . . . . . . . 173.2.2 Examples . . . . . . . . . . . . . . . 19Regulation for the design ofsafety instructions . . . . . . . . . . . 19Structure of a

13、n editorship manual. . . . . . . . . . . . . . . . . 193.3 Qualification of employees . . . . . . . . . 234 Document management . . . . . . . . . . . . . 234.1 What is document management? . . . . . . 234.2 Requirements for document management . . . . . . . . . . . . . . . . . 234.3 Document adminis

14、tration . . . . . . . . . . 254.3.1 Classification . . . . . . . . . . . . . 254.3.2 Terminology. . . . . . . . . . . . . . 254.3.3 Data formats. . . . . . . . . . . . . . 274.3.4 Maintaining documents . . . . . . . . 294.3.5 Distributing documents . . . . . . . . 314.4 Saving and archiving data and

15、 documents . . . . . . . . . . . . . . . . . . 314.4.1 Requirements for saving andarchiving data . . . . . . . . . . . . . 314.4.2 Saving data . . . . . . . . . . . . . . 334.4.3 Archiving . . . . . . . . . . . . . . . 354.5 Interfaces to internal or external service providers . . . . . . . . . . .

16、. . . . 395 Conclusions . . . . . . . . . . . . . . . . . . . 416Index. . . . . . . . . . . . . . . . . . . . . . . . 43Bibliography . . . . . . . . . . . . . . . . . . . . . 46B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08 2 VDI 4500 Blatt 2 / Part 2Alle Rechte vorbehalten Ver

17、ein Deutscher Ingenieure e.V., DsseldorfEinfhrung1 Einfhrungbersicht VDI 4500VDI 4500 Inhalte ZielgruppeBlatt 1:Begriffsdefinitionen und rechtliche GrundlagenGrundlagen der Technischen Dokumentation Dokumentationsarten Rechtliche Forderungen, Rechtsnormen Dokumentationspflichten Kundenforderungen Pr

18、oduktlebenszyklus Geschftsleiter hinsichtlich der Verantwortung und Haftung Fhrungskrfte hinsichtlich des Einsatzes qualifizierten Perso-nals und des Bereitstellens von Ressourcen Ausfhrende Personen, die mit dem Erstellen Technischer Dokumentation beauftragt sind Externe Dienstleister, die eigenver

19、antwortlich alle genannten Aufgaben ber-nehmen knnen Blatt 2:Organisieren und VerwaltenOrganisatorische Verant-wortung Schnittstellen zwischen Verantwortungen Projektmanagement Freigabeprozeduren Datensicherung undArchivierungGeschftsleiter hinsichtlich der Verantwortung und HaftungFhrungskrfte hins

20、ichtlich des Einsatzes qualifizierten Perso-nals und des Bereitstellens von Ressourcen Ausfhrende Personen, die mit dem Erstellen Technischer Dokumentation beauftragt sind Externe Dienstleister, die eigenverantwortlich Aufgaben bernehmen knnen Blatt 3:Erstellen und Verteilen von elektronischen Ersat

21、zteil-informationen Nutzergruppe und Anwen-dungsvorteile Bestandteile und Realisierung eines elektronischen Ersatzteil-katalogs Schnittstellen Datenaustausch, Austauschfor-mate Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte von Produktherstellern und -anwen-dern fr Ersatzteildokumenta-tion Exte

22、rne Dienstleister, die eigenverantwortlich Aufgaben bernehmen knnen Blatt 4:Inhalte und AusfhrungZiel- und Benutzergruppen Interne Technische Dokumen-tation Externe Technische Dokumen-tation Arten von Dokumenten Gestalten und Erstellen von Dokumenten Qualittsmanagement Werkzeuge Praxisbeispiele, Che

23、cklisten Fhrungs- und Fachkrfte, die mit dem Erstellen Technischer Dokumentation beauftragt sind Externe Dienstleister, die eigenverantwortlich Aufgaben bernehmen knnen Personen, die Informationen fr die Technische Dokumenta-tion liefern Blatt 5:Wirtschaftlich DokumentierenBetriebswirtschaftliche As

24、pekte Optimieren von Informations- und Dokumentationsprozessen Projektbezogene Kalkulation Nutzen interner Ressourcen, Einbinden externer Dienst-leister Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Bewertung von Dokumenta-tionsleistungen Kaufmnnische Fhrungs-krfte hinsichtlich der be

25、triebs-wirtschaftlichen Bewertung Technische Fhrungskrfte hinsichtlich des Umsetzbarkeit mit vorhandenen oder zuge-kauften Ressourcen Produktmanager oder Projekt-leiter hinsichtlich der kostenge-rechten Integration in den Produktlebenszyklus Ausfhrende Personen, die mit dem Erstellen und Koordinie-r

26、en Technischer Dokumenta-tion beauftragt sind B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 2 / Part 2 3 All rights reserved Verein Deutscher Ingenieure e.V., Dsseldorf 2006Introduction1 IntroductionSurvey on theVDI Guideline 4500Part of VDI 4500 Contents Target

27、groupPart 1:Definitions and legal basicsPrinciples of technical documentationTypes of technical documenta-tionLegal demands, lawsDuties of technical documenta-tionCustomers requirementsProduct life cycleManagers for responsibility and reliabilityManagers for the employment of qualified personnel and

28、 acquisition of resourcesPersonnel for the production of technical documentationExternal service providers, qualified for performing all tasks mentionedPart 2:Organization andmanagementOrganizational responsibilityInterfaces between responsibil-itiesProject managementRelease proceduresData protectio

29、n and archive managementManagers for responsibility and reliabilityManagers for the employment of qualified personnel and acquisition of resourcesPersonnel for the production of technical documentationExternal service providers, qualified for performing all tasks mentioned independentlyPart 3:Produc

30、ing and distributing electronic spare partsinformationUser group and application advantagesComponents and realization of an electronic spare partscatalogueInterfacesData exchange, exchangeformatsConcrete examples, check listsManagers and experts of prod-uct manufacturers and product users for spare

31、parts documen-tationExternal service providers, qualified for performing tasks independentlyPart 4:Contents and implementationTarget and user groupsTypes of documentsDesigning and producing documentsQuality managementToolsConcrete examples, check listsManagers and experts, who are in charge with the

32、 produc-tion of technical documentationExternal service providers, qualified for performing tasks independentlyPersons delivering information for the technical documentation Part 5:Economical documentingEconomic aspectsOptimizing information and documentation processesProject related calculationUsin

33、g internal resources,integrating of external service providersConcrete examples, check listsManagers for the assessment of documentation perform-ancesCommercial managers for economic assessmentTechnical managers for the realization possibilities with own or bought resourcesProduct managers or projec

34、t managers for cost aware inte-gration into the product life cyclePersonnel for the production and coordination of technical documentationB55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08 4 VDI 4500 Blatt 2 / Part 2Alle Rechte vorbehalten Verein Deutscher Ingenieure e.V., Dsseldor

35、fEinfhrungIhr NutzenAls eine Ergnzung zu den einschlgigen Normen zeichnet sich diese Richt-linie dadurch aus, dass die genannten Aspekte streng prozessorientiert zu in-terpretieren sind. Beim Leser wird ein entsprechendes Abstraktionsvermgenvorausgesetzt, um die Sachverhalte und Beispiele auf sein e

36、igenes Arbeitsge-biet anwenden zu knnen. Insbesondere muss er die Auswahl der fr seineAufgabe und Situation anwendbaren Dokumente im Einzelfall selbst bestim-men. Die Vollstndigkeit der Normenverweise in dieser Richtlinie ist nichtdas Ziel eine Abweichung, die sich ein Richtlinienausschuss im Gegens

37、atzzu einer Technischen Redaktion leisten darf.Zum Verstndnis der vorliegenden Richtlinie ist es erforderlich, die RichtlinieVDI 4500 Blatt 1 gelesen zu haben, die sich mit den Begriffsdefinitionen undrechtlichen Grundlagen der Technischen Dokumentation befasst. Insbeson-dere die Abschnitte, die sic

38、h mit den Verantwortlichkeiten und den rechtli-chen Voraussetzungen befassen, haben auch fr Organisation und VerwaltungTechnischer Dokumentation Bedeutung.1.1 Ihr NutzenWer heute im Unternehmen fr die betriebsorganisatorische Eingliederungder Technischen Dokumentation in die unterschiedlichen Untern

39、ehmensbe-reiche verantwortlich ist, muss wissen, welche organisatorischen Aspektebeim sachgerechten und rechtskonformen Erstellen von Dokumentationen zubeachten sind. Diese Aspekte reichen von der Organisationsverantwortungder Geschftsleitung, Fhrungskrfte und Bereichsleiter bis hin zum Doku-mentenm

40、anagement. Letzteres soll sicherstellen, dass technische Dokumenteentsprechend den rechtlichen Anforderungen ber den gesamten Produktle-benszyklus reproduzierbar, versionsgesteuert und qualittsgesichert sind.Die vorliegende Richtlinie VDI 4500 Blatt 2 beschreibt die Anforderungen andie Technische Do

41、kumentation hinsichtlich der organisatorischen und ver-waltungstechnischen Voraussetzungen.Anerkannte Regel der TechnikDie Richtlinienreihe VDI 4500 ist auf Grund des Zustandekommens nachHerausgabe der endgltigen Fassung eine Allgemein Anerkannte Regel derTechnik, die wertvolle Hilfestellung und pra

42、xisnahe Empfehlungen zur Ein-gliederung in die Organisationsstruktur und zur Verwaltung Technischer Do-kumentation gibt.1.2 Was gehrt zur Technischen Dokumentation?Technische Dokumentation beinhaltet alle technischen Informationen, dievon einem Hersteller/Vertreiber parallel zum Entstehen und zum Le

43、benswegeines Produktes erstellt werden.Bild 1 zeigt den Bereich der Technischen Dokumentation und seine Unter-teilung in Interne Technische Dokumentation die beim Hersteller ver-Blatt 6:Elektronisch PublizierenPublizieren als Teil des Infor-mationsmanagements Rechtliche Aspekte Informationszugriff,

44、Schnitt-stellen und Standards Technologien und Systeme Qualittsmanagement Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Verantwortung Verantwortliche, die fr die datentechnische Infrastruktur und die Dokumentation und Verteilung der Dokumente ver-antwortlich sind Fhrungs- und Fachkrft

45、e, die Software fr den Publikations-prozess auswhlen oder selbst erstellen Externe Dienstleister, die eigenverantwortlich Aufgaben bernehmen knnen B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 2 / Part 2 5 All rights reserved Verein Deutscher Ingenieure e.V., Dss

46、eldorf 2006IntroductionYour benefitAs an addition of the relevant standards, this guideline is characterized by thefact that the aspects mentioned are to be interpreted strictly process oriented.With the readers, an appropriate abstraction ability is presupposed, in order tobe able to apply circumst

47、ances and examples to their own sphere of activity.In particular they must determine the selection of the documents in individualcases applicable for their task and situation. The completeness of the standardreferences in this guideline is not the goal a deviation, which a guidelinecommittee may aff

48、ord in the contrary to a technical editorship.To understand this guideline it is necessary to read in advance the guidelineVDI 4500 Part 1 concerned with the definitions and legal bases of the techni-cal documentation. In particular, the sections concerning the responsibilitiesand the legal conditio

49、ns, are relevant for organization and administration oftechnical documentation.1.1 Your benefitWho ever in an enterprise nowadays is responsible for the integration of tech-nical documentation into the different divisions should know, which organi-zational aspects are to be considered with adequate and law conform provi-sion of documentations. These aspects reach from the organization responsi-bility of the management, high-level personnel and division heads up to thedocumen