Bliv klar til 2018 Be ready for 2018 Bereiten Sie sich auf 2018 vor Bliv klar til 2018 - World Translation
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
Bliv klar til 2018
Be ready for 2018
Bereiten Sie sich auf 2018 vor
Bliv klar til 2018
Fremstillingen af teknisk dokumentation bliver håndteret forskelligt fra virksomhed til virksomhed. Nogle har
allerede fint styr på det og har måske kun brug for nogle enkelte fif, mens andre først er ved at opbygge
et system for deres tekniske dokumentation og er glade for alle de oplysninger, som de kan få.
Lige meget, hvor langt du er i processen, kan du bruge vores tjekliste til at huske alle de mange aspekter,
der spiller en vigtig rolle, når du vil producere god teknisk dokumentation.
Ved at følge tjeklisten udvikler du dine egne gode vaner, som du kan bruge i fremtiden.
1 God teknisk dokumentation
Husk de følgende fire emner:
Målgruppe: Hvem skal bruge din dokumentation?
Kvalitet: Hvilken kvalitet skal din dokumentation som minimum have?
Pris: God dokumentation behøver ikke at koste en formue.
Ressourcer: Brug dine ressourcer på den bedst mulige måde.
DTP-program
Brug det rigtige DTP-program til dine dokumentationsopgaver:
Almindelige tekstopgaver = standard tekstbehandlingsprogram
Mindre/mellemstore opgaver = DTP-program
2
Mellemstore/store opgaver = DTP-program, der kan klare store mængder tekst og illustrationer.
3 Planlægning er fundamentet for hele projektet
80/20-reglen: dokumentationsprojekt = 80 % planlægning + 20 % fremstilling
Husk følgende aspekter, når du planlægger et projekt:
Informationssøgning Målgruppe Layout Sprogbrug
Standarder
Maskindirektivet stiller krav til den sikkerhedsmæssige indretning af maskiner og den
medfølgende dokumentation i EU/EØS.
Tjek om indholdet i din tekniske dokumentation overholder kravene.
4
Ret dig efter de standarder, der er relevante for din maskintype.
Husk, at brugsanvisningen altid skal leveres på brugerlandets sprog.
Gå allerede i gang med at afklare direktiver og standarder i konstruktionsfasen.5 Livscyklus for teknisk dokumentation
Dokumentationsprocessen er ikke afsluttet efter fremstillingen.
Husk følgende tre ting, når din dokumentation skal leveres med maskinen: sporbarhed, sprogversioner, medie.
Når din dokumentation anvendes, skal du være forberedt på brugerfeedback samt behov for opdateringer af
dokumentationen og dermed distribueringen af nye versioner.
Opret et system til dokumentstyring.
Outsourcing
Reducér arbejdsbyrden og brug dine ressourcer på den bedst mulige måde. Spar faste
lønomkostninger (f.eks. kontorplads, forsikring, feriepenge).
Brug en konsulent til et dokumentationsprojekt og få en stærk samarbejdspartner.
6
7 Eksport
Overvej følgende aspekter ved din tekniske dokumentation for at undgå faldgruber, når du vil
eksportere dit produkt:
Skal layoutet ændres?
Hvilket sprog skal dokumentationen være på?
Skal der bruges en anden type dokumentation i et andet land?
Hvad betyder farver i de forskellige lande?
Er der andre forskrifter på det lokale marked?
Hvad kan du gøre for at forberede din dokumentation til oversættelse?
Oversættelse
Brug en specialiseret oversættelsesleverandør for at sikre dig professionel oversættelse.
Kvalitetskriterier for oversættelse:
Kildetekst
8
Terminologi
Centralisering
Valg af oversætter
Tid
Teknologi.
Hvis du ikke har fået læst alle indlæg om de gode vaner, kan du finde dem alle på vores hjemmeside.Be ready for 2018
The production of technical documentation is handled differently from company to company. Some
companies may already have it well organised, with only the need for small adjustments here or there,
while other companies may be building up their technical documentation for the first time, and are happy
for any information and help they can get.
Regardless of where you are in this process, you can use our checklist to cover many of the aspects that
are important when it comes to producing excellent technical documentation.
By following our checklist, you will develop your own good habits, which you can use in the future.
1 Excellent technical documentation
Remember the following four topics:
Target group: Who is going to use your documentation?
Quality: What is the minimum level of quality that your documentation must have?
Price: Good documentation does not have to cost a fortune
Resources: Use your resources in the best possible way
DTP program
Use the correct DTP program for your documentation tasks:
Standard tasks = a standard word processing program
Small/medium large tasks = DTP program
2
Medium/large tasks = a DTP program that is well-suited to working with large volumes of texts and illustrations
3 Planning is the foundation of the entire project
The 80/20 rule: documentation project = 80 % planning + 20 % production
Remember the following aspects, when you plan a project:
Information searching Target group Layout Language and tone
Standards
The Machinery Directive lays down a number of requirements related to the safety of the design
and construction of machines and the accompanying documentation in EU and EEA member
countries.
4
Check the content of your technical documentation to ensure that it meets the requirements
Ensure your technical documentation complies with the standards that apply to your machine
Remember, a user manual must always be supplied in the language of the country the machine will be used in
Find out which directives and standards apply, early on during the design phase5 Lifecycle of technical documentation
The documentation process does not end after its production.
Remember the following when your documentation is to be supplied with the machine: Traceability, language
versions, media
Once your documentation is used, you should be prepared for user feedback, and the need for updating
documentation and subsequently distributing new versions
Create a document management system
Outsourcing
Reduce the workload and use your resources in the best possible way. Save fixed salary costs –
office facilities, insurance, holiday pay, etc.
Use a consultant for a documentation project and gain a strong partner.
6
7 Exports
When you export your product, consider the following aspects to avoid pitfalls when dealing with
your technical documentation:
Does the layout need to be changed?
Which language shall the documentation be written in?
Shall another type of documentation be used in another country?
What impact does colour have in different countries?
Are there other local market regulations?
What can you do to improve documentation for translation purposes?
Translation
Use a specialised translation agency to ensure that you get professional translation.
Translation quality criteria:
Source text
8
Terminology
Centralisation
Choice of translator
Time
Technology
No need to fret if you did not manage to read all of the articles about good documentation habits
when they were published, because they are still available on the website.Bereiten Sie sich auf 2018 vor
Das Erstellen technischer Dokumentation wird von Unternehmen zu Unternehmen ganz unterschiedlich
gehandhabt. Einige haben die Sache bereits im Griff und benötigen vielleicht nur den einen oder anderen
Tipp, während andere erst anfangen, ein System für ihre technische Dokumentation aufzubauen, und froh
über alle Informationen sind, die sie bekommen können.
Doch ganz egal, wie weit Sie in diesem Prozess sind, können Sie unsere Checkliste nutzen, damit Sie
keinen der vielen Aspekte übersehen, die beim Erstellen guter technischer Dokumentation eine wichtige
Rolle spielen.
Beim Verwenden der Checkliste entwickeln Sie selbst eigene gute Gewohnheiten, die Sie zukünftig
nutzen können.
1 Gute technische Dokumentation
Beachten Sie die vier folgenden Punkte:
Zielgruppe: Wer soll Ihre Dokumentation verwenden?
Qualität: Welche Qualität muss Ihre Dokumentation mindestens haben?
Preis: Gute Dokumentation muss kein Vermögen kosten.
Ressourcen: Nutzen Sie Ihre Ressourcen bestmöglich.
DTP-Programm
Verwenden Sie das richtige DTP-Programm für Ihre Dokumentationsarbeiten:
Allgemeine Textaufgaben = Standardprogramm für Textverarbeitung
Kleinere/mittlere Aufgaben = DTP-Programm
2
Mittlere/große Aufgaben = DTP-Programm, das große Mengen an Text und Abbildungen bearbeiten kann
3 Die Planung ist das Fundament für das gesamte Projekt
Die 80-zu-20-Regel: Dokumentationsprojekt = 80 % Planung + 20 % Erstellung
Beachten Sie bei der Planung eines Projekts folgende Aspekte:
Informationssuche Zielgruppe Layout Sprache
Normen
Die Maschinenrichtlinie stellt in der EU/im EWR Anforderungen an die sicherheitstechnische
Einrichtung von Maschinen und an die mitgelieferte Dokumentation.
Überprüfen Sie, ob der Inhalt Ihrer technischen Dokumentation diesen Anforderungen entspricht.
4
Richten Sie sich nach den Normen, die für Ihren Maschinentyp relevant sind.
Beachten Sie, dass die Betriebsanleitung immer in der Sprache des Landes auszuliefern ist, in dem die Maschine zum
Einsatz kommt.
Beginnen Sie bereits in der Konstruktionsphase mit dem Abklären von Richtlinien und Normen.5 Lebenszyklus für technische Dokumentation
Der Dokumentationsprozess ist mit der Erstellung nicht abgeschlossen.
Beachten Sie folgende drei Dinge, wenn Ihre Dokumentation mit der Maschine ausgeliefert werden soll:
Nachverfolgbarkeit, Sprachversionen, Medium.
Wenn Ihre Dokumentation verwendet werden soll, müssen Sie darauf vorbereitet sein, dass es zu Rückmeldungen
von Nutzern kommt, dass die Dokumentation aktualisiert werden muss und Sie sich damit um die Verteilung neuer
Versionen kümmern müssen.
Richten Sie ein System für das Dokumentenmanagement ein.
Outsourcing
Reduzieren Sie Ihre Arbeitslast und nutzen Sie Ihre Ressourcen bestmöglich. Sparen Sie sich feste
Gehaltskosten (z. B. Büroarbeitsplatz, Versicherung, Urlaubsgeld).
Lassen Sie sich von einem Berater bei einem Dokumentationsprojekt helfen und gewinnen Sie
6
damit einen starken Kooperationspartner.
7 Export
Bedenken Sie folgende Aspekte in Ihrer technischen Dokumentation, um beim Export Ihres
Produkts Fallgruben zu vermeiden:
Muss das Layout geändert werden?
In welcher Sprache muss die Dokumentation abgefasst sein?
Muss in einem anderen Land eine andere Art von Dokumentation verwendet werden?
Was bedeuten Farben in den verschiedenen Ländern?
Gibt es auf dem lokalen Markt andere Vorschriften?
Was können Sie tun, um die Dokumentation für die Übersetzung vorzubereiten?
Übersetzung
Vertrauen Sie einem spezialisierten Lieferanten von Übersetzungen, der Ihnen eine professionelle
Übersetzung garantiert.
Qualitätskriterien für die Übersetzung:
8
Ausgangstext
Terminologie
Zentralisierung
Wahl des Übersetzers
Zeit
Technologie
Wenn Sie noch nicht alle Beiträge über die guten Gewohnheiten gelesen haben, können Sie sie alle auf
unserer Webseite finden.Sie können auch lesen
