VDI 4500 Blatt 1-2006 Technical documentation - Definitions and legal basics.pdf

1、VEREIN DEUTSCHERINGENIEURETechnische DokumentationBegriffsdefinitionen und rechtliche GrundlagenTechnical documentationDefinitions and legal basicsVDI 4500Blatt 1 / Part 1Ausg. deutsch/englischIssue German/EnglishVDI-Handbuch KonstruktionVDI-RICHTLINIENICS 01.110Juni 2006June 2006Frhere Ausgaben: 02

2、.95; 12.04 Entwurf,deutschFormer editions: 02/95; 12/04 Draft, in German onlyInhalt Seite1 Einfhrung . . . . . . . . . . . . . . . . . . . 21.1 Nutzen . . . . . . . . . . . . . . . . . . . . 41.2 Was gehrt zur Technischen Dokumentation? . . . . . . . . . . . . . . . 41.2.1 Was ist Interne Technische

3、Dokumentation? . . . . . . . . . . . 41.2.2 Was ist Externe TechnischeDokumentation? . . . . . . . . . . . 62 Forderungen an die Technische Dokumentation . . . . . . . . . . . . . . . . . 102.1 Forderungen an die Interne TechnischeDokumentation . . . . . . . . . . . . . . . 102.2 Forderungen an die

4、Externe Technische Dokumentation . . . . . . . . . . . . . . . 123 Produktlebenszyklus . . . . . . . . . . . . . . 143.1 Dokumentationsphasen . . . . . . . . . . . 143.2 Aktivitten im Produktlebenszyklus . . . . 144 Forderungen aus unterschiedlichenRechtsbereichen . . . . . . . . . . . . . . . . 184

5、.1 Geregelter und freier Bereich . . . . . . . . 184.1.1 Geregelter Bereich . . . . . . . . . . 184.1.2 Freier Bereich . . . . . . . . . . . . 224.2 Allgemein Anerkannte Regeln der Technik Stand der Technik . . . . . . . . 244.3 Rechtsbegriffe und Sorgfaltspflichten juristischer und natrlicher Perso

6、nen . . . . 264.4 Erweiterte Pflichten nach dem Gesetz ber technische Arbeitsmittel und Verbraucherprodukte (GPSG). . . . . . . . 304.5 Zentralnachweis gem EG-Maschinen-richtlinie . . . . . . . . . . . . . . . . . . . 325 Fazit. . . . . . . . . . . . . . . . . . . . . . . . 346 Glossar . . . . . . .

7、 . . . . . . . . . . . . . . . 36Schrifttum . . . . . . . . . . . . . . . . . . . . . . 58Contents Page1 Introduction. . . . . . . . . . . . . . . . . . . . 31.1 Benefit . . . . . . . . . . . . . . . . . . . . 51.2 Scope of technical documentation . . . . . . 51.2.1 What is internal technical docume

8、ntation? . . . . . . . . . . . . 51.2.2 What is external technical documentation? . . . . . . . . . . . . 72 Requirements for technical documentation . . 112.1 Requirements for internal technical documentation . . . . . . . . . . . . . . . . 112.2 Requirements for external technical documentation .

9、. . . . . . . . . . . . . . . 133 Product life cycle. . . . . . . . . . . . . . . . . 153.1 Documentation phases . . . . . . . . . . . . 153.2 Activities in the product life cycle . . . . . . 154 Requirements of different legal areas . . . . . 194.1 Regulated and free area . . . . . . . . . . . 194.

10、1.1 Regulated area. . . . . . . . . . . . . 194.1.2 Free area. . . . . . . . . . . . . . . . 234.2 Generally accepted rules of technology state-of-the-art . . . . . . . . . . . . . . . . 254.3 Legal terms and care duties of legal and natural persons . . . . . . . . . . . . . . . . 274.4 Extended dut

11、ies according to the Law on Technical Equipment and Consumer Products (GPSG) . . . . . . . . . . . . . . . 314.5 Central proof according to EC MachineryDirective . . . . . . . . . . . . . . . . . . . 335Conclusion . . . . . . . . . . . . . . . . . . . . 356 Glossary. . . . . . . . . . . . . . . . .

12、. . . . . 37Bibliography . . . . . . . . . . . . . . . . . . . . . 58Die 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

13、Verlag GmbH, 10772 Berlin Alle Rechte vorbehalten / All rights reserved Verein Deutscher Ingenieure,Dsseldorf 2006Vervielfltigung auchfr innerbetriebliche Zwecke nicht gestattet / Reproduction even for internal use not permittedVDI-Gesellschaft Entwicklung Konstruktion VertriebAusschuss Technische D

14、okumentationB55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08 2 VDI 4500 Blatt 1 / Part 1Alle Rechte vorbehalten Verein Deutscher Ingenieure, Dsseldorf 2006Einfhrung1 EinfhrungDas vorliegende Blatt 1 bildet die Grundlage fr die weiteren Bltter derRichtlinie VDI 4500 Technische Dok

15、umentation“.bersicht VDI 4500VDI 4500 Inhalte ZielgruppeBlatt 1:Begriffsdefinitionen undrechtliche GrundlagenGrundlagen der Technischen Dokumentation Dokumentationsarten Rechtliche Forderungen, Rechts-normen Dokumentationspflichten Kundenforderungen Produktlebenszyklus Geschftsleiter hinsichtlich de

16、r Verantwortung und Haftung Fhrungskrfte hinsichtlich des Einsatzes qualifizierten Personals und des Bereitstellens von Res-sourcen Ausfhrende Personen, die mit dem Erstellen Technischer Doku-mentation beauftragt sind Externe Dienstleister, die eigen-verantwortlich alle genannten Auf-gaben bernehmen

17、 knnen Blatt 2:Organisieren und VerwaltenOrganisatorische Verantwortung Schnittstellen zwischen Verantwortungen Projektmanagement Freigabeprozeduren Datensicherung undArchivierungGeschftsleiter hinsichtlich der Verantwortung und HaftungFhrungskrfte hinsichtlich des Einsatzes qualifizierten Personals

18、 und des Bereitstellens von Res-sourcen Ausfhrende Personen, die mit dem Erstellen Technischer Doku-mentation beauftragt sind Externe Dienstleister, die eigen-verantwortlich Aufgaben berneh-men knnen Blatt 3:Erstellen und Verteilen von elektronischen Ersatzteil-informationen Nutzergruppe und Anwendu

19、ngs-vorteile Bestandteile und Realisierung eines elektronischen Ersatzteil-katalogs Schnittstellen Datenaustausch, Austausch-formate Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte von Produktherstellern und -anwen-dern fr Ersatzteildokumentation Externe Dienstleister, die eigen-verantwortlich A

20、ufgaben ber-nehmen knnen Blatt 4:Inhalte und AusfhrungZiel- und Benutzergruppen Arten von Dokumenten Gestalten und Erstellen vonDokumenten Qualittsmanagement Werkzeuge Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte, die mit dem Erstellen Technischer Doku-mentation beauftragt sind Externe Dienst

21、leister, die eigen-verantwortlich Aufgaben berneh-men knnen Personen, die Informationen fr die Technische Dokumentationliefern Blatt 5:Wirtschaftlich dokumentierenBetriebswirtschaftliche Aspekte Optimieren von Informations- und Dokumentationsprozessen Projektbezogene Kalkulation Nutzen interner Ress

22、ourcen, Einbinden externer Dienstleister Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Bewertung von Dokumenta-tionsleistungen Kaufmnnische Fhrungskrfte hinsichtlich der betriebswirtschaft-lichen Bewertung Technische Fhrungskrfte hinsichtlich der Umsetzbarkeit mit vorhandenen oder zug

23、ekauften Ressourcen Produktmanager oder Projekt-leiter hinsichtlich der kostenge-rechten Integration in den Produkt-lebenszyklus Ausfhrende Personen, die mit dem Erstellen und Koordinieren Technischer Dokumentation beauftragt sind Blatt 6:Elektronisch PublizierenPublizieren als Teil des Informa-tion

24、smanagements Rechtliche Aspekte Informationszugriff, Schnittstellen und Standards Technologien und Systeme Qualittsmanagement Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Verantwortung Verantwortliche fr die datentech-nische Infrastruktur und die Doku-mentation und Verteilung der Dok

25、umenteFhrungs- und Fachkrfte, die Software fr den Publikationspro-zess auswhlen oder selbst erstel-len Externe Dienstleister, die eigen-verantwortlich Aufgaben berneh-men knnen B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 1 / Part 1 3 All rights reserved Verein

26、Deutscher Ingenieure, Dsseldorf 2006Introduction1 IntroductionThis Part 1 is the basis for the further parts of guideline VDI 4500 “Technicaldocumentation“.Overview VDI 4500Part Contents Target groupPart 1:Definitions and legal basicsBasics of the technical documen-tation Types of technical document

27、ationLegal demands, lawsDuties of technical documentationCustomers requirementsProduct life cycleManager for responsibility and reli-abilityManager for the employment of qualified personnel and acquisition of resources Personnel for the production of technical documentation External service provider

28、s, quali-fied for performing all tasks men-tioned independentlyPart 2:Organizing and administratingOrganizational responsibilityInterfaces between responsibilitesProject management Release procedures Data protection and archivemanagementManager for responsibility andreliabilityManager for the employ

29、ment of qualified personnel and acquisition of resourcesPersonnel for the production of technical documentationExternal service providers, quali-fied for performing tasks inde-pendentlyPart 3:Editing and distributing elec-tronic spare parts informationUser group and application advan-tages Component

30、s and realization of an electronic spare parts catalogueInterfaces Data exchange, exchange formatsConcrete examples, check listsManagers and experts of product manufacturers and product users for spare parts documentationExternal service providers, quali-fied for performing tasks inde-pendentlyPart

31、4:Contents and performanceTarget and user groupsTypes of documentsDesigning and producing documentsQuality management Tools Concrete examples, check listsManagers and experts for the pro-duction of technical documenta-tionExternal service providers, quali-fied for performing tasks inde-pendentlyPers

32、ons delivering information for the technical documentation Part 5:Documenting economicallyEconomic aspects Optimizing information and documentation proceduresProject related calculation Using internal resources, integrat-ing of external service providersConcrete examples, check listsManagers for the

33、 assessment of documentation performancesCommercial managers for eco-nomic assessmentTechnical managers for the reali-zation possibilities with own or bought resourcesProduct managers or project man-ager for cost aware integration into the product life cycle Personnel for the production and coordina

34、tion of technical docu-mentationPart 6:Publishing electronicallyPublishing as a part of the information managementLegal aspectsInformation access, interfaces and standards Technologies and systems Quality management Concrete examples, check listsManagers for responsibilityPersonnel responsible for t

35、he data technical infrastructure and the documentation and distribution of the documentsManagers and experts who select software for the publishing proce-dure or who develop it themselvesExternal service providers, quali-fied for performing tasks inde-pendentlyB55EB1B3E14C22109E918E8EA43EDB30F09DCCB

36、7EF86D9NormCD - Stand 2012-08 4 VDI 4500 Blatt 1 / Part 1Alle Rechte vorbehalten Verein Deutscher Ingenieure, Dsseldorf 2006EinfhrungNutzenDie Tabelle zeigt die verffentlichten bzw. derzeit in Bearbeitung befind-lichen Bltter. In dieser Richtlinie zitierte Dokumente und Normen gelten nur als Beispie

37、le.Der Anwender muss von den genannten Beispielen abstrahieren und die Aus-wahl der fr seine Aufgabe und Situation anwendbaren Dokumente im Ein-zelfall selbst bestimmen. Auch ist die Vollstndigkeit der Normenverweise indieser Richtlinie nicht das Ziel gewesen eine Abweichung, die sich eineRichtlinie

38、 im Gegensatz zur realen Technischen Redaktion leisten darf.1.1 NutzenWer heute im Unternehmen fr das Erstellen von Technischer Dokumentationverantwortlich ist, muss wissen, wie diese sachgerecht und rechtskonform zuerstellen ist. Vor dem Hintergrund der Harmonisierung weltweit gltiger Nor-men und R

39、echtsvorschriften zur Technischen Dokumentation ist fundiertesWissen um die Forderungen aus verschiedenen Rechtsbereichen ntig, umdie Aufgaben der Technischen Dokumentation ber den gesamten Produkt-lebenszyklus erfllen zu knnen. Nur damit kann die eigene TechnischeDokumentation den rechtlichen Vorga

40、ben und dem Stand der Technik ent-sprechen und bei einer berprfung im Schieds- oder Schadensfall rechtlichbestehen.Gesetzliche ForderungenDie Richtlinie VDI 4500 Blatt 1 zeigt die gesetzlichen Forderungen auf, diebeim Erstellen der Technischen Dokumente sei es fr Interne oder ExterneTechnische Dokum

41、entation zu beachten sind. Klarheit im Dschungel derBegriffsbezeichnungen aus allen Bereichen Technischer Dokumentation bie-tet das umfangreiche Glossar, Checklisten helfen bei Bewertungen des eige-nen Qualittsstandards und das umfangreiche Literaturverzeichnis zeigtWege auf, das eigene Wissen auf s

42、pezifischen Fachgebieten zu vertiefen.Anerkannte Regel der TechnikDie Richtlinie VDI 4500 ist eine Allgemein Anerkannte Regel der Technik,die wertvolle Hilfestellung und praxisnahe Empfehlungen fr das ErstellenTechnischer Dokumentation gibt.1.2 Was gehrt zur Technischen Dokumentation?Technische Doku

43、mentation beinhaltet alle Informationen, die von einem Her-steller/Vertreiber parallel zum Entstehen und zum Lebensweg eines Produk-tes (Produktlebenszyklus) erstellt werden.Bild 1 zeigt den Bereich der Technischen Dokumentation und seine Unter-teilung in Interne Technische Dokumentation und Externe

44、 Technische Doku-mentation.Innerhalb dieser Richtlinie wird die Unterteilung weiter untergliedert und er-lutert.ProduktbeobachtungDie Produktbeobachtung ist in Bild 1 bei der Internen Technischen Dokumen-tation angesiedelt. Vorgaben zur Produktbeobachtung werden von den zustn-digen Bearbeitern der I

45、nternen Technischen Dokumentation erstellt und denVerantwortlichen fr die Externe Technische Dokumentation bergeben.1.2.1 Was ist Interne Technische Dokumentation?Die Interne Technische Dokumentation beinhaltet alle technischen Informa-tionen ber ein Produkt, die im Unternehmen verbleiben; sie werde

46、n in unter-schiedlichen Dokumenten nachvollziehbar festgehalten. Weiterhin umfasstsie alle notwendigen Angaben zu Entwicklung, Fertigung, anwendungsbezo-gener Prfung, Instandhaltung, Produktbeobachtung und Entsorgung. berden Umfang einer Internen Technischen Dokumentation zu einem ProduktB55EB1B3E14

47、C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 1 / Part 1 5 All rights reserved Verein Deutscher Ingenieure, Dsseldorf 2006IntroductionBenefitThe table shows the parts already published or being edited at present.Documents and standards quoted in this guideline apply as exam

48、ples only.Users have to abstain from the examples mentioned. In the concrete case, theywill have to select documents applicable to their task and situation them-selves. Further, this guideline does not intend a completeness of standardquotes a deviation, a guideline can afford in the contrary to a r

49、eal technicaleditor.1.1 BenefitWho ever in an enterprise is responsible for the production of technical doc-umentation has to know how to produce it relevantly and according to the law.On behalf of the harmonization of worldwide valid standards and legal regu-lations for the technical documentation a substantial knowledge of the re-quirements of the different legal areas is necessary to be able to perform thetasks for the technical documentation covering the who