VDI 4500 Blatt 4-2011 Technical documentation - Documentation process - Planning layout creation.pdf

1、VEREIN DEUTSCHERINGENIEURETechnische DokumentationDokumentationsprozessPlanen, Gestalten, ErstellenTechnical documentationDocumentation processPlanning, layout, creationVDI 4500Blatt 4 / Part 4Ausg. deutsch/englischIssue German/EnglishVDI-Handbuch Produktentwicklung und KonstruktionVDI-RICHTLINIENIC

2、S 01.110 Dezember 2011December 2011Frhere Ausgabe: 12.09 Entwurf, deutschFormeredition: 12/09Draft, 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 asauthorit

3、ative.Zubeziehen durch /Available at BeuthVerlag GmbH,10772 Berlin AlleRechtevorbehalten /All rights reserved Verein Deutscher Ingenieuree.V.,Dsseldorf 2011Vervielfltigung auchfr innerbetrieblicheZwecke nichtgestattet / Reproduction evenfor internal use not permittedVDI-Gesellschaft Produkt- und Pro

4、zessgestaltung (GPP)Fachbereich Technischer Vertrieb und ProduktmanagementInhalt SeiteVorbemerkung . . . . . . . . . . . . . . . . . . . 2Einleitung . . . . . . . . . . . . . . . . . . . . . 21 Anwendungsbereich . . . . . . . . . . . . . 41.1 Ihr Nutzen . . . . . . . . . . . . . . . . . 41.2 Was geh

5、rt zur Technischen Dokumentation? . . . . . . . 62 Vom Produktlebenszyklus zumDokumentationsprozess . . . . . . . . . . . 83 Dokumentation planen . . . . . . . . . . . . 123.1 Dokumentenarten. . . . . . . . . . . . . . 123.2 Planungsschritte . . . . . . . . . . . . . . 123.3 Daten aufbereiten. . . .

6、 . . . . . . . . . . 244 Dokumentation gestalten . . . . . . . . . . 264.1 Grundstze . . . . . . . . . . . . . . . . . 284.2 Layout, Farbe, Text und Bild. . . . . . . . 284.3 Ausgabemedium . . . . . . . . . . . . . . 305 Dokumentation erstellen . . . . . . . . . . . 305.1 Strukturieren . . . . . . .

7、 . . . . . . . . . 305.2 Modularisieren . . . . . . . . . . . . . . . 345.3 Standardisieren . . . . . . . . . . . . . . . 365.4 Erstellen . . . . . . . . . . . . . . . . . . 385.5 Endfassung . . . . . . . . . . . . . . . . . 425.6 Dokumentation anpassen. . . . . . . . . . 446 Qualittsmanagement . .

8、. . . . . . . . . . 466.1 Schwachstellenanalyse . . . . . . . . . . . 486.2 Prfungen am Produkt . . . . . . . . . . . 546.3 Akzeptanzuntersuchungen . . . . . . . . . 546.4 Anforderungen an den Technischen Redakteur. . . . . . . . . . . . . . . . . . 56Glossar . . . . . . . . . . . . . . . . . . . .

9、. . 60Schrifttum . . . . . . . . . . . . . . . . . . . . . 67Contents PagePreliminary note . . . . . . . . . . . . . . . . . . 3Introduction . . . . . . . . . . . . . . . . . . . . 31 Scope . . . . . . . . . . . . . . . . . . . . . 51.1 Your benefit . . . . . . . . . . . . . . . . 51.2 What constitu

10、tes technical documentation? . . . . . . . . . 72 From the product lifecycle up todocumentation process . . . . . . . . . . . 93 Planning of documentation . . . . . . . . . 133.1 Document types . . . . . . . . . . . . . . 133.2 Planning steps . . . . . . . . . . . . . . . 133.3 Preparation of data .

11、 . . . . . . . . . . . . 254 Layout of documentation . . . . . . . . . . 274.1 Basic principles . . . . . . . . . . . . . . 294.2 Layout, Colour, Text and Image . . . . . . 294.3 Output medium . . . . . . . . . . . . . . 315 Creation of documentation . . . . . . . . . 315.1 Structuring . . . . . . .

12、 . . . . . . . . . . 315.2 Modularising. . . . . . . . . . . . . . . . 355.3 Standardisation. . . . . . . . . . . . . . . 375.4 Creation . . . . . . . . . . . . . . . . . . 395.5 Final version . . . . . . . . . . . . . . . . 435.6 Adapting of documentation . . . . . . . . 456 Quality management . .

13、. . . . . . . . . . . 476.1 Weak point analysis . . . . . . . . . . . . 496.2 Acceptance tests with the product itself . . 556.3 Acceptance tests . . . . . . . . . . . . . . 556.4 Requirements that the technical writermust meet . . . . . . . . . . . . . . . . . 57Glossary . . . . . . . . . . . . . .

14、 . . . . . . . . 61Bibliography . . . . . . . . . . . . . . . . . . . . 67B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF8AD9NormCD - Stand 2012-04 2 VDI 4500 Blatt 4 / Part 4 Alle Rechte vorbehalten Verein Deutscher Ingenieure e.V., Dsseldorf 2011VorbemerkungVorbemerkungDer Inhalt dieser Richtlinie ist

15、entstanden unter Beachtung der Vorgaben undEmpfehlungen der Richtlinie VDI 1000.Alle Rechte, insbesondere die des Nachdrucks, der Fotokopie, der elektroni-schen Verwendung und der bersetzung, jeweils auszugsweise oder vollstn-dig, sind vorbehalten.Die Nutzung dieser VDI-Richtlinie ist unter Wahrung

16、des Urheberrechts undunter Beachtung der Lizenzbedingungen (www.vdi-richtlinien.de), die in denVDI-Merkblttern geregelt sind, mglich.Allen, die ehrenamtlich an der Erarbeitung dieser VDI-Richtlinie mitgewirkthaben, sei gedankt.Eine Liste der aktuell verfgbaren Bltter dieser Richtlinienreihe ist im I

17、nter-net abrufbar unter www.vdi.de/4500.EinleitungDie vorliegende Richtlinie VDI 4500 Blatt 4 behandelt Planung, Gestaltungund Erstellung im Dokumentationsprozess. Die folgende bersicht zeigtBlatt 4 im Kontext der Richtlinienreihe VDI 4500.Blatt Inhalte ZielgruppeBlatt 1:Begriffsdefinitionen und rec

18、htliche Grundlagen Grundlagen der Technischen Dokumentation Dokumentationsarten rechtliche Forderungen,Rechtsnormen Dokumentationspflichten Kundenforderungen Produktlebenszyklus Geschftsleiter hinsichtlich der Verant-wortung und Haftung Fhrungskrfte hinsichtlich des Einsat-zes qualifizierten Persona

19、ls und des Bereitstellens von Ressourcen ausfhrende Personen, die mit dem Erstellen Technischer Dokumentation beauftragt sind externe Dienstleister, die eigenverant-wortlich Aufgaben bernehmen knnen Blatt 2:Organisieren und Verwalten organisatorische Verant-wortung Schnittstellen zwischenVerantwortu

20、ngen Projektmanagement Freigabeprozeduren Datensicherung und Archivierung Geschftsleiter hinsichtlich der Verant-wortung und Haftung Fhrungskrfte hinsichtlich des Einsat-zes qualifizierten Personals und des Bereitstellens von Ressourcen ausfhrende Personen, die mit dem Erstellen Technischer Dokument

21、ation beauftragt sind externe Dienstleister, die eigenverant-wortlich Aufgaben bernehmen knnen Blatt 3:Erstellen und Vertei-len von elektroni-schen Ersatzteil-informationen Nutzergruppe undAnwendungsvorteile Bestandteile und Realisie-rung eines elektronischen Ersatzteilkatalogs Schnittstellen Datena

22、ustausch, Austausch-formate Praxisbeispiele, Checklisten Fhrungs- und Fachkrfte von Pro-duktherstellern und -anwendern fr Ersatzteildokumentation externe Dienstleister, die eigenverant-wortlich Aufgaben bernehmen knnen Blatt 4:Dokumentations-prozess: Planen Gestalten Erstellen Ziel- und Benutzergrup

23、pen Bausteine der Prozesskette Werkzeuge Qualittsmanagement Fhrungs- und Fachkrfte, die mit dem Erstellen Technischer Dokumentation beauftragt sind externe Dienstleister, die eigenverant-wortlich Aufgaben bernehmen knnen Personen, die Informationen fr die Technische Dokumentation liefern B55EB1B3E14

24、C22109E918E8EA43EDB30F09DCCB7EF8AD9NormCD - Stand 2012-04VDI 4500 Blatt 4 / Part 4 3 All rights reserved Verein Deutscher Ingenieure e.V., Dsseldorf 2011Preliminary notePreliminary noteThe content of this guideline has been developed in strict accordance with therequirements and recommendations of t

25、he guideline VDI 1000.All rights are reserved, including those of reprinting, reproduction (photocop-ying, micro copying), storage in data processing systems and translation,either of the full text or of extracts.The use of this guideline without infringement of copyright is permitted sub-ject to th

26、e licensing conditions specified in the VDI Notices (www.vdi-rich-tlinien.de).We wish to express our gratitude to all honorary contributors to this guideline.A catalogue of all available parts of this series of guidelines can be accessedon the internet at www.vdi.de/4500.IntroductionThe present guid

27、eline VDI 4500 Part 4 deals with planning, layout and crea-tion in the documentation process. The following overview shows Part 4 inthe context of the series of guidelines VDI 4500.Part Contents Target groupPart 1:Definitionsand legalbasics basic principles of technical documentation documentation t

28、ypes legal requirements, legal standards documentation duties customer requirements product lifecycle managing directors in respect of respon-sibility and liability senior managers with respect to the deployment of qualified personnel and the provision of resources executives who are assigned the ta

29、sk of creating technical documentation external service providers, who can dis-charge duties under their own responsi-bilityPart 2:Organisation andmanagement organisational responsibility interfaces between responsi-bilities project management approval procedures data protection and archiving managi

30、ng director in respect of responsibility and liability senior managers in respect of the deploy-ment of qualified personnel and provision of resources executives who are assigned the task of creating technical documentation external service providers, who candischarge duties under their own respon-s

31、ibilityPart 3:Producing and dis-tributing electronicspare parts infor-mation user group and advantages of use components and implementa-tion of an electronic spare parts catalogue interfaces data exchange, exchangeformats practical examples, checklists experts and management of product manufacturers

32、 and users for spare parts documentation external service providers, who can assume tasks under their own responsi-bilityPart 4:Documentationprocess: planning layout creation target and user groups modules of the process chain tools quality management experts and management, who are entrusted with t

33、he task of creating techni-cal documentation external service providers, who can assume duties under their own responsi-bility persons who deliver information for tech-nical documentationB55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF8AD9NormCD - Stand 2012-04 4 VDI 4500 Blatt 4 / Part 4 Alle Rechte vorb

34、ehalten Verein Deutscher Ingenieure e.V., Dsseldorf 2011AnwendungsbereichIhr 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 Abstraktionsver

35、mgenvorausgesetzt, damit er die Sachverhalte und Beispiele auf sein eigenes Ar-beitsgebiet anwenden kann. Insbesondere muss er die Auswahl der fr seineDer Prozess steht im VordergrundAufgabe und Situation anwendbaren Dokumente im Einzelfall selbst bestim-men. Ziel der Richtlinie VDI 4500 Blatt 4 ist

36、 nicht die Vollstndigkeit derNormenverweise und anderer Ausfhrungsdetails, stattdessen steht die Pro-zessbetrachtung im Vordergrund.Grundlage zum Verstndnis von Blatt 4 ist die Richtlinie VDI 4500 Blatt 1.Diese befasst sich mit den Begriffsdefinitionen und rechtlichen Grundlagender Technischen Dokum

37、entation. Insbesondere die Abschnitte, die sich mitden Verantwortlichkeiten und den rechtlichen Voraussetzungen befassen, gel-ten auch fr die Schritte Planen, Gestalten und Erstellen im Dokumentations-prozess.1 AnwendungsbereichDie Inhalte der Richtlinie VDI 4500 Blatt 4 wenden sich an die Ersteller

38、 vonTechnischer Dokumentation und besonders an die Zielgruppe der Techni-schen Redakteure, die im klassischen Sinn Externe Technische Dokumenta-tion erstellen.1.1 Ihr NutzenWer heute im Unternehmen fr Konzeption, Ausfhrung und Verteilung vonTechnischer Dokumentation verantwortlich ist, muss sich dam

39、it auseinander-setzen, welche Arten von Dokumenten bentigt werden und wie diese zu er-stellen sind. Zustzlich sind Kenntnisse ber die zweckmigen Werkzeugeund ber die Qualitt von Technischer Dokumentation notwendig.Blatt Inhalte ZielgruppeBlatt 5:Dokumentations-prozess:Wirtschaftlichdokumentieren bet

40、riebswirtschaftliche Aspekte Optimieren von Informations- und Dokumentationsprozes-sen projektbezogene Kalkulation Nutzen interner Ressourcen,Einbinden externer Dienst-leister Praxisbeispiele, Checklisten Geschftsleiter hinsichtlich der Bewer-tung von Dokumentationsleistungen kaufmnnische Fhrungskrf

41、te hin-sichtlich der betriebswirtschaftlichen Bewertung technische Fhrungskrfte hinsichtlich des Umsetzbarkeit mit vorhandenen oder zugekauften Ressourcen Produktmanager oder Projektleiter hin-sichtlich der kostengerechten Integra-tion in den Produktlebenszyklus ausfhrende Personen, die mit dem Erst

42、ellen und Koordinieren Technischer Dokumentation beauftragt sind Blatt 6:Dokumentations-prozess: Publizieren Publizieren als Teil desDokumentationsprozesses rechtliche Aspekte Informationszugriff, Schnitt-stellen und Standards Technologien und Systeme Qualittsmanagement Praxisbeispiele, Checklisten

43、Verantwortliche, die fr die datentechni-sche Infrastruktur, die Dokumentation und die Verteilung der Dokumente ver-antwortlich sind Fhrungs- und Fachkrfte, die Soft-ware fr den Publikationsprozess aus-whlen oder selbst erstellen externe Dienstleister, die eigenverant-wortlich Aufgaben bernehmen knne

44、n B55EB1B3E14C22109E918E8EA43EDB30F09DCCB7EF8AD9NormCD - Stand 2012-04VDI 4500 Blatt 4 / Part 4 5 All rights reserved Verein Deutscher Ingenieure e.V., Dsseldorf 2011ScopeYour benefitAs an addition to the pertinent standards, this guideline is characterised by thefact that the aforementioned aspects

45、 are to be interpreted in a strictly process-oriented context. It is assumed that the reader has a certain ability to abstract,so that he can apply the facts and examples to his own area of work. In par-ticular, he must himself determine the selection of the documents applicableThe process is at the

46、forefrontto his task and situation in the individual case. Aim of the guideline VDI 4500Part 4 is not the completeness of the references to standards and other layoutdetails; the focus is rather on the process examination.Basis for the understanding of Part 4 is the guideline VDI 4500 Part 1. Thisde

47、als with the term definitions and legal bases of technical documentation. Inparticular, the sections that deal with the responsibilities and the legal prereq-uisites are equally applicable to the steps of planning, layout and creation ofthe documentation process.1 ScopeThe contents of the guideline

48、VDI 4500 Part 4 are addressed to the creators oftechnical documentation and especially to the target group of technical writ-ers, who create external technical documentation in the classic sense.1.1 Your benefitWhoever is responsible today in the company for the conception, layout anddistribution of

49、 technical documentation, must deal with the question as towhich types of documentation are needed and how these are to be created.Additionally, knowledge of the advantageous tools and about the quality oftechnical documentation is needed.Part Contents Target groupPart 5:Documentationprocess:economicaldocumentation business managerial aspects optimising of information and documentation process