Teknisk dokumentation

fra Wikipedia, den gratis encyklopædi
Spring til navigation Spring til søgning

Teknisk dokumentation (også teknisk dokumentation eller produktdokumentation ) omfatter alle informationsprodukter , der beskriver et teknisk produkt og giver vejledning i brug, vedligeholdelse eller reparation. Det forbereder systematisk oplysningerne og strukturerer det på en sådan måde, at det respektive formål opfyldes fuldt ud. Den tekniske dokumentation er normalt klart tildelt det dokumenterede produkt ved hjælp af navne- og nummersystemer.

Formålet med den tekniske dokumentation

Den tekniske dokumentation bruges til at give oplysninger og instruktioner til definerede målgrupper , til at beskytte producenten mod ansvar , produktovervågning , sporbarhed og reproducerbarhed samt permanent eller lovligt påkrævet arkivering af det relevante informationsindhold.

Komponenterne i den tekniske dokumentation giver oplysninger om selve produktet, hvordan det bruges, og hvordan brugerne opfører sig. De overvejer alle faser af produktets liv, fra udvikling til bortskaffelse, i nogle tilfælde inklusive fremstilling af de foreløbige produkter.

Intern og ekstern teknisk dokumentation

For teknisk dokumentation skelnes der ifølge VDI 4500 mellem intern og ekstern teknisk dokumentation:

  • Den interne tekniske dokumentation bruges til intern arkivering af alle produktrelevante dokumenter og forpligtelsen til at fremlægge bevis for, at alle juridiske forpligtelser er overholdt. Det omfatter hele produktets livscyklus fra produktplanlægning til udvikling, markedsføring og produktovervågning til produktafbrydelse. Oplysningerne forbliver normalt hos producenten, som arkiverer dem permanent og holder dem opdaterede i hele produktets levetid. Typiske komponenter er specifikationer , beregningsdokumenter, testrapporter, risikovurderinger , tekniske tegninger og produktionsdokumenter , beviser for kvalitetssikringsforanstaltninger og al ekstern teknisk dokumentation for produktet.
Den interne dokumentation opbevares normalt af producentens udviklings- eller konstruktionsafdeling.
  • Den eksterne tekniske dokumentation tjener til at informere operatøren og brugeren om produktet og sikrer, at produktet kan sættes i drift, bruges, vedligeholdes og om nødvendigt bortskaffes sikkert og efter hensigten.
Den eksterne dokumentation oprettes normalt af tekniske forfattere og oversættes normalt til den respektive brugers sprog. Afhængigt af produktet, målgruppen og lovkrav er forskellige navne og formularer mulige, f.eks. Brugsanvisning , installationsvejledning, monteringsvejledning , korte instruktioner, brugervejledning, brugsanvisning, logbog, serviceinstruktioner, onlinehjælp, vejledning, etc.

Særlige undertyper af teknisk dokumentation skyldes lovkrav, såsom ansøgningspligt til bemyndigede organer (eksempel: teknisk dokumentation i henhold til direktiv 94/9 / EF " ATEX ").

Retsgrundlag

For at sikre produktsikkerhed kræver statslige love og forskrifter for privatretlige organisationer, at producenter og installatører af tekniske produkter skal levere den tekniske dokumentation.

I EU er der relevante EF -direktiver såsom maskindirektivet , ATEX -direktivet , lavspændingsdirektivet, direktivet om trykudstyr eller produktsikkerhedsdirektivet, der er blevet implementeret af medlemsstaterne i national lovgivning (f.eks. Tysk produktsikkerhedslov eller lov om medicinsk udstyr ).

I tilfælde af skade resulterer forkert teknisk dokumentation i producentens ansvar , som følger af produktansvarsloven , den tyske civillov (§ 823 erstatningsansvar) og eventuelle individuelle kontraktlige forpligtelser.

Normer

DIN , VDE , VDI og CEN skaber standarder og retningslinjer . I engelsk brug skelnes der ikke mellem normer og standarder . Internationale standarder er skabt og leveret af ISO (som er registreret hos FN som verdensomspændende koordinerende standardiseringsorgan). Standarder for nationale organisationer som den amerikanskeANSI eller den russiske GOST anerkendes også internationalt. Yderligere standardiseringsorganer findes f.eks. I IEC , IMO , IATA og ICAO , hvoraf nogle organiserer og koordinerer deres arbejde direkte med ISO.

Retningslinjer for design af teknisk dokumentation eller brugerinformation findes i form af forskellige standarder og retningslinjer, EN 82079 eller VDI 4500. Dokumentationen til kraftværker er reguleret i VGB-retningslinjen VGB-S-831-00, levering af teknisk dokumentation (Tekniske systemdata, dokumenter) til energiforsyningssystemer .

EN 61355 regulerer klassificering og mærkning af dokumenter i den tekniske dokumentation for anlæg, systemer og faciliteter.

I nogle industrisektorer bruges forskellige standarder, retningslinjer og specifikationer afhængigt af civil eller militær anvendelse af et produkt. Inden for luftfart er disse for eksempel ATA100 / ATA2000 -specifikationen i den civile sektor og S1000D -specifikationen inden for forsvarsteknologi , hvorved civile standarder også bruges til forsvarsmateriale og omvendt. Prioriteten i standarderne, retningslinjerne (EU) og specifikationerne for forsvarsmateriale er reguleret i § 14 i DIREKTIV 2009/81 / EG [1] samt i DIN EN 16341 .

For fysisk håndtering af skriftlige og elektroniske dokumenter er den internationale standard ISO 15489 ( arkivstyring / registrering ).

Terminologi (begreber) i teknisk produktdokumentation regulerer blandt andet DIN 199 .

Dokumentationssystem

Arbejde med dokumentation er en aktivitet, der kan planlægges. Systematisk produktion, herunder teknisk dokumentation, bør derfor følge en plan, som igen udvides og ændres under behandlingen.

struktur

Den tekniske dokumentation skal være organiseret og struktureret logisk. For at gøre håndteringen lettere grupperes visse dokumenter tematisk eller på lignende måde som produktets struktur og administreres med modulære dokumentlister og indholdsfortegnelser. En ændringshistorik er almindelig med henblik på sporbarhed af revisionsniveauer . Standarder som DIN 6789 giver et levende overblik over dokumentationssystemet.

En bestemt struktur understøtter en valgt visning af et lager af dokumentation. Derfor kan denne struktur ikke opfylde alle krav på samme tid i samme omfang. Et indeks formidler mellem en særlig struktur og mulige yderligere særlige interesser i en anden orden.

Struktureringsmetoder

Særligt brugerinformation stiller høje krav til klarhed og forståelighed. Der er struktureringsmetoder, såsom informationskortteknologi eller funktionelt design, for at strukturere ofte komplekse oplysninger klart og præsentere dem på en letforståelig måde. Disse gør det lettere for indholdet at blive registreret og gør det lettere for brugeren af ​​dokumenterne at finde de oplysninger, de leder efter. Strukturering understøtter også oprettelse, administration, genbrug og offentliggørelse af indhold med et redaktionelt system .

Brug af farver og kontraster i sikkerheds- og advarselsmeddelelser

I henhold til den amerikanske standardANSI Z535.6 samt den europæiske standard EN 82079-1 kan advarselsmeddelelser , sikkerhedsoplysninger og produktsikkerhedsmærkater vises i sort og hvid, i gråtoner eller i farver. Den internationale standard DIN EN ISO 12100-2 (maskinsikkerhed) tilskynder til brug af farve i følgende forstand: "Brug af farve bør overvejes, især for komponenter, der kræver hurtig identifikation." Farver kan have forskellige intensiteter (fuld tone eller lettere ved screening) og kan bruges til forskellige formål. Især i udformningen af symboler og piktogrammer har farven til formål at tydeligt understrege kommandoer og forbud. Når du bruger farver, skal du passe på altid at markere det samme med den samme farve og gøre tegnene rige i kontrast. Det skal også bemærkes, at brugere med synshandicap ( rødgrøn svaghed , farveblindhed ) skal kunne fortolke sikkerhedsinstruktionerne korrekt. Når du opretter sikkerhedsoplysningerne, skal kontrasten mellem baggrunden og signalordet være så stor som muligt. For at garantere en ensartet kvalitetsstandard ved brug af signalfarver er vejledende værdier for de respektive signalfarver defineret i amerikanske og europæiske standarder. Specifikationerne for ANSI Z535.1 og / eller den internationale standard ISO 3864-4 tjener som en vejledende værdi for farveprint. Mens ANSI -standarden anvender Munsell -farvesystemet , bruger de europæiske direktiver RGB- eller CMYK -farvemodellen . Det individuelle farveindtryk afviger altid lidt fra målet, men dette er ikke et stort problem i praksis. Internationalt standardiserede og koordinerede sikkerhedsskilte findes i den internationale standard DIN EN ISO 7010 .

Tekniske sprog

Teknisk dokumentation gør brug af nomenklaturen sædvanlig i det respektive brugerfællesskab og et højt specialiseret ordforråd. Brugerne af dette sprog finder godt rundt i det, udenlandske læsere bliver nødt til at nærme sig dette sprog gennem synonymordbog .

Sproglige særpræg

Ud over struktureringsmetoderne er brugeroplysningerne også en sproglig teksttype med visse primære mål, herunder:

Sprogligt opfyldes disse krav af et begrænset eller kontrolleret sprog , især med en inhomogen gruppe forfattere. Sprogkontrollen omfatter, afhængigt af kontrolniveauet, følgende regler og begrænsninger:

Disse sproglige begrænsninger registreres af terminologi og om nødvendigt af redaktionelle retningslinjer og kan understøttes af passende sprogkontrolprogrammer (Controlled Language Checker).

Forskellige sprog

Da tekniske produkter ofte eksporteres til et stort antal lande på grund af deres høje specialiseringsgrad, oversættes ekstern dokumentation og brugerinformation for det meste til en række nationale eller regionale sprog . For at disse oversættelser kan udføres omkostningseffektivt, bør tekniske forfattere være opmærksomme på kravene til oversættelsestilpasset skrivning under oprettelsen. Dette emne diskuteres også i dag under overskriften lokalisering . For at understøtte en høj kvalitet oversættelse, oversættelse hukommelse systemer anvendes som oversætter og gemme ikke kun enkelte ord, men også visse dele af sætninger.

Udarbejdelse af teknisk dokumentation

Alle producentens tekniske funktionsområder er ideelt inkluderet i oprettelsen af ​​den tekniske dokumentation for et produkt. Specifikationer , funktionelle specifikationer , risikoanalyser samt konstruktions- og produktionsdokumenter oprettes af udviklings- og byggeafdelinger. Kvalitetssikringsdokumenter oprettes eller anskaffes af specialister bestilt til dette formål. Dokumenter, der skal integreres fra leverandører og underleverandører producenter er ønsket af indkøbsafdelinger .

Oprettelsen af ​​ekstern dokumentation kræver især særlig ekspertise og kvalifikationer. Denne opgave er overdraget til tekniske redaktører, der ofte er ansvarlige i specialafdelinger - tekniske redaktører - både for at redigere brugeroplysninger og for at koordinere tværgående afdelingsdokumentationsprocesser.

Delbetingelser

Disse vilkår er direkte relateret til hovedbegrebet teknisk dokumentation. De bruges til forskellige formål og på en kundeorienteret måde.

  • IETD - Interaktiv elektronisk teknisk dokumentation
  • IETP - Interaktiv elektronisk teknisk publikation
  • IETM - Interaktiv elektronisk teknisk manual

Forfatterværktøjer

Forfatterværktøjer (ger.: Hjælp til redigeringsværktøjer, kort sagt: HAS) er specielle softwareværktøjer, der tillader online hjælp og andre informationsprodukter oprettes.

litteratur

Weblinks

Faglige foreninger

Teknisk ordbog

Retningslinier

Yderligere information

Individuelle beviser

  1. Direktiv 2009/81 / EF