Technische Dokumentation

Transkript

1 Technische Dokumentation

2 Warum Technische Dokumentation Pflicht ist? Weil sie Ihnen nutzt! Gute Gebrauchs- und Investitionsgüter gibt es viele am Markt. Gut, wenn Ihre Anwender wissen, was sie davon haben. Und wie sie Ihre Produkte in vollem Umfang nutzen können. Noch besser, dass Sie mit professioneller Technischer Dokumentation Rückfragen im Haus reduzieren, dass Ihr Verkauf für die Zukunft profitiert, dass die Zufriedenheit mit Ihrem Unternehmen wächst. Und zwingend: dass mit den Informationen aus der Technischen Dokumentation auch umfangreiche Haftungsvorgaben erfüllt werden.

3 Wir bei Dokuwerk nehmen die Perspektive des Benutzers ein, wenn wir Technische Dokumentationen verfassen. Wir wissen, dass die aussagekräftige Technische Dokumentation ein überzeugendes Verkaufsargument darstellt. Wir sind hinsichtlich nationaler und internationaler Richtlinien und Normen immer auf dem neuesten Stand. Und wir haben das Wissen der Techniker und Ingenieure und setzen deshalb schon in einem frühen Stadium Ihrer Entwicklung an. Schließlich soll die Auslieferung Ihrer Produkte ohne Zeitverluste stattfinden. Das muss selbstverständlich sein? Sie haben recht! Unsere Mitarbeiter. Mitdenker! Ein Team aus technischen Redakteuren, Grafikern und Lektoren stellt Ihre Produktinformationen zusammen und bündelt die Besonderheiten Ihres Produktes in idealer Weise. So schafft Technische Dokumentation Nähe zu Informationen, Technik und Produkten. Mit Menschen. Mit Nutzen.. 25 erfahrene Technik-Redakteure, Grafiker, Lektoren und Übersetzungsmanager. Persönlicher Ansprechpartner. Recherche, Konzeption, Erstellung Technische Dokumentation, z.b.:. Betriebsanleitungen. Gebrauchsanweisungen. Bedienungsanleitungen. Wartungs- und Reparaturdokumentationen. Ersatzteilkataloge. Online-Hilfen. Lösungen für mobile Geräte. Sprachneutrale Anleitungen und Illustrationen Branchen:. Maschinen-, Anlagen- und Apparatebau. Medizin- und Pharmazietechnik. Software

4 Wollen Sie Menschen vertrauen? Wir auch! Sprachneutral. Unmissverständlich. Sprachneutrale Anleitungen und Illustrationen verbinden ohne Worte. Wenn sie dem Kulturkreis und Kenntnisstand vor Ort entsprechen. Als ganz eigene Form der Technischen Dokumentation sind sprachneutrale Anleitungen und Abbildungen selten Nachschlagewerk, dafür einmalige Instruktion für eine Montage oder Inbetriebnahme. Besonderer Vorteil? Zusammenhänge können deutlicher dargestellt, verdeckt ablaufende Vorgänge sichtbar gemacht werden. Entscheidend für die Verständlichkeit ist die klare und eindeutige Aussage unter Berücksichtigung der rechtlich-normativen Anforderungen. Wir bei Dokuwerk prüfen, wo eine Abbildung Text ergänzen oder sogar ersetzen kann und unsere Grafiker und Gestalter arbeiten dann mit den jeweils geeigneten bildhaften Möglichkeiten: perspektivischen Darstellungen als Strichzeichnungen oder Illustrationen, Explosionszeichnungen, fotorealistischen Grafiken. Und wir übernehmen auch die Fotografie und Bildbearbeitung. Dabei setzen wir u.a. folgende Programme ein: Adobe Creative Suite, CorelDESIGNER, PTC Arbortext IsoDraw.

5 Am Anfang: die Analyse.. Bestandsaufnahme zu Auftragsbeginn: Wie ist die bestehende Dokumentation beschaffen? Wo sind die Stärken? Was lässt sich verbessern? Welche Anforderungen sollen künftig berücksichtigt werden? Alles außer Standard: Software Dokumentation. Leicht versionierbar, geeignet für die parallele Pflege unterschiedlicher Releases, bei Inhalt und GUI konsistent in der Terminologie so soll Ihre Software Dokumentation sein. Sie wissen: Die Anforderungen an eine Software Dokumentation sind vielfältig. Die Erwartungen der verschiedenen Zielgruppen sind es ebenso. Bei Dokuwerk berücksichtigen wir bereits in der Konzeption diese Erfordernisse, für den einfachen Anwender wie für den erfahrenen Administrator. Das schätzen auch unsere Auftraggeber. Warum das so ist? Wir bauen Ihre Software Dokumentation modular auf. Wir optimieren für die gedruckte Nutzung sowie den Online-Einsatz, eingebettet in Ihrer Software: direkt integriert mit Kontext bezogenen Informationen und ohne Screenshots, gedruckt mit Screenshots als vollständiges Handbuch.. klassifizierbare Schwachstellen sind u.a.: Verständlichkeit Text-Bild-Zusammenhang Konsistenz in der Formulierung Zielgruppenorientierung. Systematisch werden nach der Methode Problemtypologie, entwickelt von Prof. Schäflein-Armbruster, alle Aspekte erfasst und präzise benannt.. Das Ergebnis: Grundlage unserer Optimierung!

6 Wo wir mit dem Minimum rechnen? Bei Ihrem Haftungsrisiko! Wie gut kennen Sie Ihre Anwender? Selbst die sorgfältige Konstruktion birgt ein Restrisiko. Wir wollen, dass Sie ein Haftungsrisiko weitgehend ausschließen können. Deshalb benennen unsere produktbegleitenden Instruktionen, z. B. Betriebsanleitungen, mögliche Risiken für den Benutzer schon im Vorfeld klar und verständlich und führen Maßnahmen zur Vermeidung von Gefährdungen auf. Für Hersteller gelten mit dem Inverkehrbringen von Produkten eine Vielzahl von nationalen und internationalen Richtlinien und Normen, darunter sicherheitsrelevante Aspekte: Richtlinie 2001/95/EG: Die Produktsicherheitsrichtlinie gilt für alle Produkte und enthält entscheidende Angaben zu Anforderungen an Anleitungen. Richtlinie 2006/42/EG: Die Maschinenrichtlinie enthält Angaben zu Mindestinhalten von Betriebsanleitungen, zu deren Übersetzung und zur Risikobeurteilung. DIN EN ist die Norm für das Erstellen von Anleitungen. Im Zuge der Vereinheitlichung der Konformitätsverfahren wurden 2014 neun Richtlinien überarbeitet, u. a. die Druckgeräterichtlinie (2014/29/EG), Explosionsschutzrichtlinie (2014/34/EU ATEX), EMV Richtlinie (2014/30/ EU), Niederspannungsrichtlinie 2014/35/EU. Jede der Richtlinien verlangt vom Hersteller die Durchführung einer Risikobeurteilung, eine klar verständliche Betriebsanleitung, die dem Produkt beigefügt und in der Landessprache des EU Landes abgefasst ist.

7 Anstelle Risiko. Unsere Redaktionsarbeit. Ein typisches Dokumentationsprojekt verläuft in 6 Schritten: Wir berücksichtigen diese Anforderungen täglich. Deshalb können wir Ihnen mit Sicherheit sagen, welche davon für Sie relevant sind. Welche produktspezifischen Richtlinien und Normen zu berücksichtigen sind. Wie Restrisiken ermittelt und in der Anleitung hervorgehoben, behandelt und abgebildet werden können. Damit Ihre Technische Dokumentation den geltenden Anforderungen gerecht wird. 1. Technik-Redakteure recherchieren die Projektgrundlagen. In der Phase machen wir Sie auf Aspekte aufmerksam, die von Ihnen möglicherweise (noch) nicht beachtet wurden, z.b.: Liegt eine Risikobeurteilung vor? Sind die Zielgruppen bekannt? 2. Sie erhalten ein verbindliches Angebot mit detaillierter Beschreibung unserer Lieferungen und Leistungen. 3. Mit Ihrem Auftrag beginnt unsere Redaktionsarbeit, eigenständig und mit einem Minimum an Unterstützung von Ihrer Seite. Wir verwenden Software auf dem aktuellen Stand, prüfen auf die Standardisierbarkeit, erstellen Grafiken auf Basis von CAD-Daten. 4. Wir liefern Ihnen ein Korrekturexemplar. Damit haben Sie Gelegenheit, die Inhalte auf fachliche Richtigkeit und Vollständigkeit zu prüfen. 5. Sie geben uns ein Feedback und wir stellen die Dokumentation fertig. 6. Nach Ihrer erteilten Freigabe erhalten Sie alle von uns erstellten Quelldaten.

8 Warum wir uns mit Standards zufrieden geben? Weil wir sie neu definieren! Wir sind überzeugt: Qualität braucht Standards. Das Funktionsdesign ist eine etablierte Standardisierungsmethode für die Technische Dokumentation, entwickelt in den 1990er Jahren von Robert Schäflein-Armbruster und Jürgen Muthig. Das Funktionsdesign als anerkanntes Verfahren stellt die Konsistenz, die ökonomische Erstellung einer Dokumentation und ihre Verständlichkeit sicher. Wesentliches Prinzip der Methode ist es, die Inhalte aus sogenannten funktionalen Elementen aufzubauen und diese nach einheitlichen Beschreibungsmustern klar zu definieren.

9 Unser Know-how: Ihr Redaktionsleitfaden. Der Kern eines Redaktionsleitfadens enthält das für Ihr Unternehmen ausgearbeitete Funktionsdesign, nach Möglichkeit um Beispiele aus Ihren Dokumentationen ergänzt. Ihr Redaktionsleitfaden beantwortet Fragen, die im Einzelfall zu uneinheitlicher Formulierung, Auszeichnung oder innerer Struktur führen könnten. Und er enthält typischerweise grundlegende Schreibregeln, Beispiele zur Veranschaulichung der Definitionen und die Definition der Dokumentstruktur mit den erforderlichen Vorrat aller Elemente des Funktionsdesigns. Sie erwarten mehr Unterstützung? Dann beschreiben wir außerdem das gesamte Aufgabenspektrum der Redaktionsabteilung, erarbeiten entsprechende Regeln, z.b. zu erforderlichen Redaktionsprozessen, bieten Hilfen für die Nutzung der Software, einen Erfassungsleitfaden als Werkzeug der Redaktion oder einen Grafikleitfaden an.

10 Wo macht Dokuwerk den Unterschied? In der Qualität! Sie möchten die Dokumentationserstellung in Teilen oder vollständig auslagern bzw. als Dienstleistung einkaufen? Weil Sie Entlastung erwarten. Ihre Redaktionsarbeit professionalisieren wollen. Und Kosten senken. Gern! Grundlage für unser Modell der Zusammenarbeit ist eine Rahmenvereinbarung, vergleichbar einem Service Level Agreement. Hier einigen wir uns beispielsweise über die Vereinbarung zur Auftragsdurchführung, zu Gewährleistungen und der Rechteübertragung. Unser Anspruch: Qualität. In der Durchführung. Und in unseren Ergebnissen.

11 Qualitätsmanagement. Und Zertifizierungen.. Qualitätsmanagement zertifiziert nach ISO 9001:2008 Redaktionsprozesse nach DIN EN gemäß DocCert System Fragen Sie gern nach unseren Referenzen! Ihre Redaktion. Unser Schema. Vertrauen. Verlagern! Wir sorgen dafür, dass Sie auf der sicheren Seite sind. Mit der Erfahrung aus über anspruchsvollen Projekten und mit ausgereiften Redaktionsprozessen. Nach ISO 9001:2008 und DocCert System sind wir für die hohe Qualität unserer Leistungserbringung zertifiziert. Was Sie davon haben? Unsere Konzentration auf Kernkompetenzen: Sie planen und konstruieren. Wir übernehmen die Technische Dokumentation und versetzen uns dabei in die Rolle Ihres Anwenders. In unserer Methode Funktionsdesign vereinen wir effiziente Erstellung und Darstellung. Und können eine definierbare Lieferqualität am Ende der Wertschöpfung garantieren. Dabei können Sie unserem festen Mitarbeiterteam durchweg vertrauen. Ihr Vorteil:. Schema ST4 ist eines der führenden Redaktionssysteme. Wir sind zertifizierter Schema Silberpartner. Mit umfassendem Know-how für komplexe Prozesse von der Erfassung bis zur Publikation Entscheidend für Sie: Die Wirksamkeit und Einhaltung unserer Redaktion ist geprüft. Von der Recherche bis zur Freigabe.

12 Wissen ist gut. Teilen besser! Uns bei Dokuwerk scheint es erstrebenswert, Wissen zu teilen. So schätzen wir das Feedback unserer Auftraggeber, weil uns jede Herausforderung gemeinsam weiter bringt. Wir kennen die Anforderungen an Prozesse und Tools aus Redaktion und Übersetzung. Sind auf dem aktuellen Stand der Technik. Und geben unser Wissen um neue Prozesse bei Katalogproduktion, Übersetzung und Technischer Dokumentation gerne weiter. Für die gesamte Region D-A-CH. Und insbesondere im Maschinen- und Anlagenbau, der Geräte- und Apparatetechnik, der Softwaredokumentation und in unterschiedlichen Bereichen der Investitionsgüterindustrie. Verlassen Sie sich auf etablierte Methoden, wirkungsvolle Standards, unsere langjährige Erfahrung und aktuelle Erkenntnisse. Und auf die große Flexibilität unsere 25 langjährigen Mitarbeiter am Standort Friedrichshafen. Ihr Ansprechpartner Martin Gundlach Tel.: Fax: Dokuwerk KG Otto-Lilienthal-Straße 6 D Friedrichshafen