Technische Dokumentation: Vom Problemkind zum Klassenbesten

Transkript

1 Technische Dokumentation: Vom Problemkind zum Klassenbesten Pascal Kesselmark Leiter Technische Dokumentation Klingelnberg AG, Zürich

2 Über mich Journalist/Autor Technikredaktor mit eidg. Fachausweis Ing. EurEta Informatik Leiter Technische Dokumentation seit 2002 Leiter TechDoc Seit 2008 Präsident

3 Über Klingelnberg Gegründet 1863 Familiengeführt in der 7. Generation International führende Firma im Bereich Zahnradtechnologie Mehr als 1000 Mitarbeiter in der Klingelnberg Gruppe Umsatz der Klingelnberg Gruppe: ca. 175 m

4 Standorte Klingelnberg AG, Zürich Klingelnberg GmbH, Hückeswagen Aussenstelle Ettlingen Klingelnberg AG in Zürich, Schweiz früher als Oerlikon Gear Tech bekannt, ist der Hauptsitz. Fabrikationsstätten sind in Hückeswagen, Deutschland und Zürich, Schweiz. Das TechCenter ist in Ettlingen, Deutschland.

5 Klingelnberg Team an 4 Standorten (Europa & Asien) Technische Redakteure, Terminologie und Übersetzungsmanagement Quellsprache ist Deutsch Ca. 600 Dokumente pro Jahr (TechDoc) Dokumentenumfang: Seiten Übersetzung in 12 Hauptsprachen

6 Redaktionssystem Redaktionssystem

7 Themen in der Technischen Dokumentation

8 Abnahme Arbeitsumgebung Belastung Betriebsmittelvorschriften Budget Dienstleister Freigabe Grafiken Informationsmangel Kreativität Kundenanforderungen Kundenspezifisch Lieferantendokumentation Maschinenoptionen Normen Priorität Produktionslänge Prozesse Rechtssicher Redaktionsleitfaden Redaktionsschluss Redaktionssystem Regeln Schnittstellen Schreibregeln Softwareentwicklung Sprachvarianten Standard Status Struktur Terminologie Terminplan Terminverzug Text Tools Überlastung Übersetzungsdauer übersetzungsgerecht Verantwortlichkeiten Vorgesetzte Wichtigkeit

9 Von 2008 bis heute

10

11

12

13

14

15

16

17

18

19

20

21

22

23 Und wie?

24 Wir verbesserten alles 1. 9-Punkte-Plan zur optimalen Dokumentation 2. Einsetzen einer Autorenunterstützung 3. Fehlende Funktionen die nicht erhältlich sind, selbst mit VBA programmieren lassen

25 Der 9-Punkte-Plan zur optimalen Dokumentation

26 Das wurde getan: 1. Informa*onsbedarf und Zielgruppen analysieren 2. Problemanalyse der bestehenden Dokumente 3. Dokumente definieren und strukturieren 4. Musterdokumente erstellen 5. Wiederverwendbare seman*sche Strukturen iden*fizieren 6. Redak*onellen Standard für Text und Bild setzen 7. Prozesse analysieren und definieren 8. (Redak*onssystem implemen*eren,) Redakteure trainieren 9. Dokumente und Prozesse regelmässig überprüfen und verbessern

27 Analyse Informationsbedarf Ziel Charakterisierung der Zielgruppen: Rollen, Nutzungssituationen, Wissensvoraussetzungen, Strategien Konformität mit rechtlich geforderten Mindestangaben Kunden-/marktgerechte Portionierung/Detaillierung Alles Entbehrliche abspecken! Methoden Befragungen Workshops Hotline-Auswertung Mut zum Verzicht auf rechtlich nicht geforderte Informationen oder diese als kostenpflichtige Zusatzleistung anbieten

28 Analyse Informationsbedarf Zielgruppen bei Klingelnberg

29 Probleme analysieren

30 Prozesse analysieren Analysieren, wo Zeit «verloren» geht Wer ist für welche Inhalte verantwortlich? Wer muss Freigabe erteilen? Wer trägt am Schluss die Verantwortung? Welche repetitiven Aufgaben könnten automatisiert werden?

31 Umfeld vorbereiten Vorlagen Automatisierung durch VBA, FrameScript usw. Strukturierungsmethoden Semantische Strukturierung Inhaltsstruktur erstellen tekom Leitfaden «Betriebsanleitungen» Redaktionssystem wäre gut, benötigt aber Knowhow und Investitionen Schrott in = Schrott out! Zeiteinsparung erst in der Pflege und Übersetzung Miete ist teilweise auch möglich! Standards definieren Status der Technischen Dokumentation im Unternehmen

32 Umfeld vorbereiten

33 Umfeld vorbereiten Standardisierte Sicherheits- und Warnhinweise EG-Maschinenrichtlinie 2006/42/EG EN ISO 12100: Sicherheit von Maschinen EN 62079: Erstellen von Anleitungen, Gliederung, Inhalt und Darstellung -> EN EN 1050: Sicherheit von Maschinen. Leitsätze zur Risikobeurteilung ISO /2: Graphical symbols Safety colours and safety signs ANSI Z : American National Standard for Enviromental and Facility Safety Signs

34 Umfeld vorbereiten Technische Dokumentation im Unternehmen Sichtbar werden Stellenwert erhöhen Investitionen dem Management über ROI «verkaufen»

35 Inhalte optimieren Redaktionellen Standard für Text und Bild setzen Ökonomische und qualitätsgesicherte Textproduktion nach eindeutigen und einfachen Regeln Optimale Fütterung Translation Memory-Systeme und optimale Verständlichkeit für die Nutzer Entlastung der Redaktion (ggf. Entwicklung) von Formulierungs- und Gestaltungsaufgaben Die Basis automatisch generierter und stimmiger Dokumente legen Terminologie normen, Nutzung und Pflege sichern Übersetzungsgerechte Inhalte -> Leitfaden «Regelbasiertes Schreiben» (tekom.de)

36 Inhalte optimieren

37 Inhalte optimieren

38 Inhalte optimieren

39 Inhalte optimieren

40 Inhalte optimieren Qualitätsprüfung der Quelltexte Analyse der häufigsten Probleme und deren Logik Definieren einer Prüfroutine

41 Redakteure trainieren Feedback durch Korrekturen Redaktionssitzung tekom/tecom Veranstaltungen Persönliche Weiterbildung Mitarbeit im Verband

42 Übersetzungsdauer reduzieren Inhaltlich Terminologie (Abgestimmt mit Markt) Übersetzungsgerechte Inhalte Grafiken Texte QS der Quellsprache vor dem Übersetzen QS der fertigen Übersetzungen Prozess Vorab-Übersetzungen Keine Marktfreigabe der Übersetzung! Tools Prüfen, ob Übersetzungsumgebung im Zielland grosse Verwendung hat. Je nach Hersteller kann die Projektverwaltung 50 % länger dauern. In extremen Fällen einen Tag anstatt einer Stunde. Schnittstellen Redaktionssystem und Übersetzungsumgebung.

43 Termintreue verbessern Wann muss was in welcher Qualität verfügbar sein? Genug, damit nicht «Nachgebessert» werden muss! Produktionsdaten/Liefertermine im Griff haben Redaktionsschluss festlegen und kommunizieren (-x Wochen) Übersetzer Vorab «reservieren» (mind. 3 Wochen) Teillieferungen

44 Mut zur Lücke Dokument muss zur Maschinenabnahme vorhanden sein Praxis: Bei einer neuen Maschine wird bis zum letzten Tag «optimiert» --> Doku? Übersetzung?... Nachlieferung möglich, da Maschine im Normalfall ein paar Wochen unterwegs ist.

45 Einsetzen einer Autorenunterstützung

46 Autorenunterstützung Anzeige von bestehenden Inhalten während des Schreibens Prüfung anhand des Translation Memories Prüfung der Terminologie Eigene Prüfregeln Prüfung der Grammatik

47

48

49

50

51

52 Fehlende Funktionen selbst entwickeln

53 VBA-Makros Prüfungen auf Modul- und Dokumentebene Individualisierte Symbolleiste Strukturtemplates Abbildungs- und Tabellenverzeichnisse

54 Klingelnberg Symbolleiste Nur die in der Vorlage definierten Absatzformate sind erlaubt. Alle anderen Formate werden reklamiert. Das Format «Standard» wird automatisch umgewandelt.

55 Richtige Sequenzierung durch Autotexte Fügt eine komplette Muster-HA ein Jedes Mal neu und nicht eine alte HA kopieren

56 Semantische Struktur HA Abgeleitete Regeln: Nach «L0:Handlung» darf kommen Vor Marginale muss «L1: Handlung_Ende» kommen Alle anderen Formate sind nicht erlaubt

57 Modularisierung Im RLF definiert, dass maximal 1 Überschrift pro Modul erlaubt ist

58 Abbildungsgröße Probleme beim Import von Übersetzungen Grafiken/Bilder dürfen NIE skaliert werden Speichern im Redaktionssystem wird verhindert 2% Toleranz für Word If (ishape.scaleheight >= (100 - unteres_abmass) And ishape.scaleheight <= (100 + oberes_abmass)) _ And (ishape.scalewidth >= (100 - unteres_abmass) And ishape.scalewidth <= (100 + oberes_abmass)) _ Then

59 Kleinigkeiten Text ohne Formatierung einfügen Sub TextEinfuegen() Selection.PasteAndFormat (wdformatplaintext) End Sub Brauchbares Abbildungs- und Tabellenverzeichnis

60

61

62 Zusammenfassend Ein stabiles «Fundament» ist das Wichtigste: 9 Punkte Plan umsetzen oder Beratung einkaufen Erst dann die richtigen Tools beschaffen Konstant die Inhalte und Prozesse verbessern Seien Sie kreativ mit den Lösungen (und nicht den Inhalten)

63 Resultat Konsistente und rechtssichere Dokumente Höhere Wiederverwendung von Inhalten Weniger Probleme mit Übersetzungen und es ist schneller und günstiger Besseres Erlebnis für den Benutzer dank eines kombinieren Ansatzes von Regeln, Autorenunterstützung und QS

64 Fragen? Jetzt, oder kontaktieren Sie mich später unter: