VDI 4500 Blatt 3-2006 Technical documentation - Producing and distributing electronic spare parts information.pdf

1、VEREIN DEUTSCHERINGENIEURETechnische DokumentationErstellen und Verteilen von elektronischen ErsatzteilinformationenTechnical documentationProducing and distributing electronic sqare parts informationVDI 4500Blatt 3 / Part 3Ausg. deutsch/englischIssue German/EnglishVDI-Handbuch KonstruktionVDI-RICHT

2、LINIENICS 01.110Juni 2006June 2006Frhere Ausgabe: 12.01 Entwurf,deutschFormer edition: 12/01 Draft, in German onlyInhalt Seite1 Einfhrung . . . . . . . . . . . . . . . . . . . . 21.1 Nutzen . . . . . . . . . . . . . . . . . . . . 41.2 Elektronische Ersatzteilkataloge als Teilder Technischen Dokument

3、ation . . . . . . 62 Elektronischer Ersatzteilkatalog (eETK) . . . 62.1 Nutzergruppen und Anwendungsvorteile. . 62.2 Bestandteile und Realisierung eines eETK . 102.3 Checkliste fr die Umsetzung. . . . . . . . 203 Schnittstellen und Datenaustausch . . . . . . 223.1 Schnittstellen . . . . . . . . . .

4、. . . . . . 223.2 Datenaustausch . . . . . . . . . . . . . . . 264 Formate fr den Ersatzteil-Datenaustausch . 324.1 Austauschformate fr die bildliche Darstellung . . . . . . . . . . . . . . . . . 324.2 Austauschmodelle fr Ersatzteil-informationen . . . . . . . . . . . . . . . . 324.3 Zeichnungen und

5、 Hotspots . . . . . . . . . 385 Beispiele aus der Praxis . . . . . . . . . . . . 425.1 XML-basierter Lsungsansatz . . . . . . . 425.2 Automatisches Generieren einesErsatzteilkatalogs im Anlagenbau . . . . . 525.3 Standardisierte Investitionsgter . . . . . . 585.4 Serienprodukte . . . . . . . . . . .

6、 . . . . 64Glossar . . . . . . . . . . . . . . . . . . . . . . . . 68Schrifttum . . . . . . . . . . . . . . . . . . . . 80Contents Page1 Introduction. . . . . . . . . . . . . . . . . . . . 31.1 Advantage . . . . . . . . . . . . . . . . . . 51.2 Electronic spare parts catalogues as a part of the tech

7、nical documentation . . . . . . . 72 Electronic spare parts catalogue (eETK) . . . 72.1 User groups and application advantages. . . 72.2 Components and realisation of an eETK . . 112.3 Checklist for the realisation . . . . . . . . . 213 Interfaces and data exchange. . . . . . . . . . 233.1 Interface

8、s . . . . . . . . . . . . . . . . . . . 233.2 Data exchange . . . . . . . . . . . . . . . . 274 Formats for the spare parts data exchange . . 334.1 Exchange formats for illustrations . . . . . . . . . . . . . . . . . . 334.2 Exchange models for spare parts information . . . . . . . . . . . . . . . .

9、 . . 334.3 Drawings and hotspots . . . . . . . . . . . . 395 Examples from practice . . . . . . . . . . . . . 435.1 XML based solution approach . . . . . . . . 435.2 Automatic generation of an electronic spareparts catalogue in the installation production 535.3 Standardised capital goods. . . . . .

10、. . . . 595.4 Mass products . . . . . . . . . . . . . . . . 65Glossary . . . . . . . . . . . . . . . . . . . . . . . 69Bibliography . . . . . . . . . . . . . . . . . . . . . 80Die deutsche Version dieser Richtlinie ist verbindlich. No guarantee can be given with respect to the English transla-tion.

11、The German version of this guideline shall be taken asauthoritative.Zu beziehen durch / Available at Beuth Verlag GmbH, 10772 Berlin Alle Rechte vorbehalten / All rights reserved Verein Deutscher Ingenieure,Dsseldorf 2006Vervielfltigung auchfr innerbetriebliche Zwecke nicht gestattet / Reproduction

12、even for internal use not permittedVDI-Gesellschaft Entwicklung Konstruktion VertriebAusschuss Technische DokumentationB55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08 2 VDI 4500 Blatt 3 / Part 3Alle Rechte vorbehalten Verein Deutscher Ingenieure, Dsseldorf 2006Einfhrung1 Einfhru

13、ngDie vorliegende Richtlinie VDI 4500 Blatt 3 definiert die grundlegenden An-forderungen an die Schnittstellen eines elektronischen Ersatzteilkatalogs(eETK) zwischen Lieferanten, Herstellern und Kunden.bersicht VDI 4500VDI 4500 Inhalte ZielgruppeBlatt 1:Begriffsdefinitionen und recht-liche Grundlage

14、nGrundlagen der Technischen Dokumentation Dokumentationsarten rechtliche Forderungen, Rechtsnormen Dokumentationspflichten Kundenforderungen Produktlebenszyklus Geschftsleiter hinsichtlich der Verantwortung und Haftung Fhrungskrfte hinsichtlich des Einsatzes qualifizierten Personals und des Bereitst

15、ellens von Res-sourcen ausfhrende Personen, die mit dem Erstellen Technischer Doku-mentation beauftragt sind externe Dienstleister, die eigen-verantwortlich alle genannten Auf-gaben bernehmen knnen Blatt 2:Organisieren und VerwaltenOrganisatorische Verantwortung Schnittstellen zwischen Verantwortung

16、en Projektmanagement Freigabeprozeduren Datensicherung undArchivierungGeschftsleiter hinsichtlich der Verantwortung und HaftungFhrungskrfte hinsichtlich des Einsatzes qualifizierten Personals und des Bereitstellens von Res-sourcen ausfhrende Personen, die mit dem Erstellen Technischer Doku-mentation

17、 beauftragt sind externe Dienstleister, die eigen-verantwortlich Aufgaben berneh-men knnen Blatt 3:Erstellen und Verteilen von elektronischen Ersatzteil-informationen Nutzergruppe und Anwendungs-vorteile Bestandteile und Realisierung eines elektronischen Ersatzteil-katalogs Schnittstellen Datenausta

18、usch, Austausch-formate Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte von Produktherstellern und -anwen-dern fr Ersatzteildokumentation externe Dienstleister, die eigen-verantwortlich Aufgaben berneh-men knnen Blatt 4:Inhalte und AusfhrungZiel- und Benutzergruppen Arten von Dokumenten Gestalte

19、n und Erstellen vonDokumenten Qualittsmanagement Werkzeuge Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte, die mit dem Erstellen Technischer Doku-mentation beauftragt sind externe Dienstleister, die eigen-verantwortlich Aufgaben berneh-men knnen Personen, die Informationen fr die Technische Dok

20、umentation liefern Blatt 5:Wirtschaftlich dokumentierenbetriebswirtschaftliche Aspekte Optimieren von Informations- und Dokumentationsprozessen projektbezogene Kalkulation Nutzen interner Ressourcen, Einbinden externer Dienstleister Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Bewert

21、ung von Dokumenta-tionsleistungen kaufmnnische Fhrungskrfte hinsichtlich der betriebswirtschaft-lichen Bewertung technische Fhrungskrfte hinsichtlich des Umsetzbarkeit mit vorhandenen oder zugekauften Ressourcen Produktmanager oder Projektlei-ter hinsichtlich der kostengerech-ten Integration in den

22、Produkt-lebenszyklus ausfhrende Personen, die mit dem Erstellen und Koordinieren Technischer Dokumentation beauftragt sind Blatt 6:Elektronisch publizierenPublizieren als Teil des Informa-tionsmanagements rechtliche Aspekte Informationszugriff, Schnittstellen und Standards Technologien und Systeme Q

23、ualittsmanagement Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Verantwortung Verantwortliche fr die datentech-nische Infrastruktur und die Doku-mentation und Verteilung der DokumenteFhrungs- und Fachkrfte, die Software fr den Publikations-prozess auswhlen oder selbst erstellen extern

24、e Dienstleister, die eigen-verantwortlich Aufgaben ber-nehmen knnen B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 3 / Part 3 3 All rights reserved Verein Deutscher Ingenieure, Dsseldorf 2006Introduction1 IntroductionThis guideline VDI 4500 Part 3 defines the basi

25、c requirements for the inter-faces of an electronic spare parts catalogue (eETK) between deliverers, man-ufacturers and customers.Overview VDI 4500Part Contents Target groupPart 1:Definitions and legal basicsBasics of the technical documen-tation Types of technical documentationLegal demands, lawsDu

26、ties 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 providers, quali-fied for performi

27、ng all tasks men-tioned independentlyPart 2:Organizing and administratingOrganizational responsibilityInterfaces between responsibilitiesProject management Release procedures Data protection and archivemanagementManager for responsibility andreliabilityManager for the employment of qualified personn

28、el 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 Components and realizition of an e

29、lectronic 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 4:Contents and performanc

30、eTarget 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-pendentlyPersons delivering informatio

31、n 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 assessment of documentat

32、ion 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 coordination of technical docu-me

33、ntationPart 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 the data technical infrast

34、ructure 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-pendentlyB55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 201

35、2-08 4 VDI 4500 Blatt 3 / Part 3Alle Rechte vorbehalten Verein Deutscher Ingenieure, Dsseldorf 2006EinfhrungNutzenDie bersicht VDI 4500“ zeigt die verffentlichten oder derzeit in Bearbei-tung befindlichen Bltter. In dieser Richtlinie zitierte Dokumente und Normen gelten nur als Beispiele.Der Anwende

36、r 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 im Gegensatz

37、zur realen Technischen Redaktion leisten darf. ZumVerstndnis des vorliegenden Blattes 3 ist es hilfreich und in Teilen sogar er-forderlich, VDI 4500 Blatt 1 und Blatt 2, die sich mit den Grundlagen derTechnischen Dokumentation befassen, gelesen zu haben.1.1 NutzenEs ist Stand der Technik, dass Ersat

38、zteilkataloge elektronisch erstellt und berelektronische Medien oder Druckmedien verteilt werden. Konsequenterweisebefasst sich die VDI 4500 Blatt 3 neben der Definition der notwendigenEingangsdaten vorwiegend mit den Schnittstellen zwischen Lieferantenund Kunden, den geeigneten Formaten fr die einz

39、elnen Ersatzteilinformati-onen und mit Anstzen fr die Realisierung von elektronischen Ersatzteilka-talogen in der Praxis. Diese Richtlinie will Standardisierungsempfehlungengeben und damit Hilfestellungen und Lsungswege bieten fr das Nutzendurchgngiger und einheitlicher Datenstrukturen und Datenform

40、ate bei derErstellung von eETK (elektronischen Ersatzteilkatalogen). Es ermglicht denAnwendern eigene betriebsspezifische Lsungen aus den dargestellten Kon-zepten abzuleiten. Dazu stellt diese Richtlinie Lsungsvorschlge fr De-tailfragen und Ausfhrungsbeispiele aus der Praxis zur Verfgung.Bild 1. Ele

41、ktronische Ersatzteilinformationen als Teilbereich der Technischen Dokumentationzu 1: Zugekaufte Teile und Komponenten werden in die unternehmensinterne Technische Doku-mentation mit Stammdaten aufgenommen.zu 2: Lieferanten, die Systeme liefern, stellen die Ersatzteilinformationen ber eine definiert

42、eSchnittstelle zur Verfgung.zu 3: Aus allen relevanten Unterlagen wird die Ersatzteilinformation fr den Kunden erstellt.B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08VDI 4500 Blatt 3 / Part 3 5 All rights reserved Verein Deutscher Ingenieure, Dsseldorf 2006IntroductionAdvantage

43、The “Overview VDI 4500” shows the parts already published or being editedat present.Documents and standards quoted in this guideline apply as examples only.Users have to abstain from the examples mentioned. In the concrete case, theywill have to select documents applicable to their task and situatio

44、n them-selves. Further, this guideline does not intend a completeness of standardquotes a deviation, a guideline can afford in the contrary to a real technicaleditor. VDI 4500 Part 1 and Part 2 deal about the basics of the technical doc-umentation. In order to understand this Part 3 it would help an

45、d partly itwould be necessary having read VDI 4500 Part 1 and Part 2.1.1 AdvantageTo produce spare parts catalogues electronically and to distribute them viaelectronic media or print media, is state-of-the-art. As a consequence,VDI 4500 Part 3 deals besides the definition of the necessary input data

46、 first of all with the interfaces between deliverers and customers, with the ad-equate formats for the single spare parts information and with approaches torealise electronic spare parts catalogues practically. This guideline wants togive standardisation recommendations and thus to offer solutions f

47、or the useof thoroughly and consistent data structures and formats for the production ofeETK (electronic spare parts catalogues). It enables the users to derive owncompany specific solutions from the presented conceptions. For this purpose,This guideline provides solution proposals for detail object

48、ives and practicalexamples.Figure 1. Electronic spare parts information as a partial field of the technical documentationat 1: Bought parts and components are integrated in the company internal technical docu-mentation with their basic data.at 2: Deliverers who deliver systems make their spare parts

49、 information available via a definedinterface.at 3: From all relevant documents the spare parts information for the customer will be generated.B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF86D9NormCD - Stand 2012-08 6 VDI 4500 Blatt 3 / Part 3Alle Rechte vorbehalten Verein Deutscher Ingenieure, Dsseldorf 2006Elektronischer Ersatzteilkatalog (eETK)Elektronische Ersatzteilkataloge als Teil der Technischen Dokumentation1.2 Elektronische Ersatzteilkataloge als T