LinoPro Logo Ball

Technische Dokumentation

Technische Dokumentation von Profis

Unsere Technische Redaktion

Unsere Technische Redaktion

Alle Konstruktionsleiter kennen das: Sie können Ihr Produkt erst dann an Ihren Kunden ausliefern, wenn die vorgeschriebene Technische Dokumentation zur Verfügung steht. Die Zeit ist knapp und der zuständige Konstrukteur mäßig motiviert, sich mit „Papierkram“ jenseits seiner Kernkompetenz zu beschäftigen. Am Ende erledigt er den Job nebenbei, während er bereits an einem anderen Modell konstruiert oder die nächste Baustelle plant. Heraus kommt nicht selten eine Technische Dokumentation, die

  • der Anwender nicht versteht,
  • die Aufsichtsbehörden nicht akzeptieren würden (müsste sich in einem Haftungsfall ein Gericht mit ihr auseinandersetzen),
  • die Marketingabteilung verärgert, weil die Technische Dokumentation das Corporate Design Ihrer Firma oder Ihres Kunden ignoriert,
  • obendrein nicht fristgerecht fertiggestellt wird und deshalb Vertragsstrafe kostet.

An dieser Stelle kommen wir „ins Spiel“. Kümmern Sie sich um Ihre Kernkompetenz. Unsere Technischen Redakteure erledigen den Papierkram von der Betriebsanleitung bis zur CE-Kennzeichnung. Wir als Konstruktionsbüro besitzen zehn Jahre Erfahrung auf dem Gebiet der Technischen Dokumentation in einer Vielzahl von Branchen. Dazu gehören u.a. der Maschinen- und Anlagenbau, die Kraftfahrzeugtechnik, die Messtechnik, die Sensorik, die Softwareentwicklung und die Technische Gebäudeausrüstung. Vom tekom-zertifizierten Technischen Redakteur über Elektroingenieure, Maschinenbauer und Techniker bis hin zu Journalisten wissen unsere Redakteure, was sie tun. Wir können Ihr Produkt verstehen und Ihrem Kunden verständlich machen. Die Gesellschaft für Technische Kommunikation (tekom e.V.) ist der größte europäische Fach- und Berufsverband für Technische Kommunikation. An deren Standards orientieren wir uns. So stellen wir sicher, dass Ihre Technische Dokumentation zum Erfolg Ihres Produktes beiträgt. Wir sorgen dafür, dass sie sowohl den Regeln des Gesetzgebers als auch den Qualitätsanforderungen der einschlägigen Normen und Standards entspricht.

Suchen Sie einen langfristigen Partner? Gerne. Wenn Sie Ihre gesamte Technische Dokumentation zu uns outsourcen, entfallen mittelfristig alle Einarbeitungsaufwände. Und wir gewähren Ihnen 20 Prozent Nachlass auf unseren Standardstundensatz ab dem siebten Mannmonat.

Ihre interne Technische Dokumentation

Ihre Maschine oder Installation kann funktional und sicher sein. Glauben wird Ihnen das im Zweifel ein Kunde oder eine Aufsichtsbehörde erst, wenn sie die entsprechende interne Technische Dokumentation vorlegen können. Auf Nachfrage müssen Sie in der Lage sein, die korrekte Auslegung, Risikobeurteilung und Qualitätssicherung Ihres Produktes nachzuweisen. Die Technische Redaktion in unserem Konstruktionsbüro hilft Ihnen bei der Erstellung eines Dokumentationskonzeptes. Außerdem beraten wir Sie bei der Wahl der richtigen Software zur Erstellung, Pflege und Archivierung der internen Technischen Dokumentation und unterstützen Sie beim Anlegen dieser Unterlagen. Wenn Sie alle notwendigen Dokumente über den gesamten Produktlebenszyklus Ihres Produktes wiederfinden, haben Sie im Haftungsfall einfach die besseren Karten! Das Konstruktionsbüro von LinoPro erstellt für Sie auf Wunsch technische Zeichnungen, Explosionszeichnungen, Prüfnachweisberechnungen, Schemata, Stücklisten und Pflichtenhefte sowie Vorlagen für Prüfprotokolle. Die Erarbeitung der Risikobeurteilung nach EN ISO 12100:2010 übernehmen wir in Kooperation mit Ihren Entwicklungsingenieuren.

Ihre externe Technische Dokumentation

Ihre externe Technische Dokumentation

„Das Produkt ist klasse – hoffentlich schaut niemand jemals in die Betriebsanleitung.“ Wenn Ihnen diese Sorge bekannt vorkommt, können wir sie Ihnen abnehmen. Eine Betriebsanleitung, die besser zum billigen Imitat aus Fernost als zu Ihrem Produkt passt, könnte für den potenziellen Käufer den wichtigen Unterschied zwischen Perfektion und Plunder verschwimmen lassen.

Wir erstellen für Sie Betriebsanleitungen, Montageanleitungen, Softwareanleitungen, Technische Datenblätter, Sicherheitsdatenblätter, Schnellstartanleitungen, Wartungsanleitungen, Schulungsmaterial, Kataloge, Tutorials und Online-Hilfen. Die externe Technische Dokumentation muss auf die Anwendergruppe zugeschnitten sein, damit sie verstanden wird und das Produkt sicher gebraucht werden kann. Technisches Bedien- und Wartungspersonal benötigt andere Details als die Nutzer von Consumer-Produkten. Wir treffen in der Technischen Dokumentation die Sprache und Auffassungsgabe Ihrer Kunden. Denn schließlich sollen diese mehr Zeit mit Ihrem Produkt als mit Ihrer Betriebsanleitung verbringen.

Natürlich können Sie zwischen unserem Handbuch-Standard-Layout, Ihrem Corporate Design oder einer freien Gestaltung ganz nach Ihren Wünschen wählen. Auf Wunsch fertigt unser Konstruktionsbüro Technische Illustrationen Ihrer 2D-Zeichnungen und 3D-Modelle an oder bearbeitet CAD-Modelle für die Aufnahme in eine Technische Dokumentation auf. Denn dem Kunden sollten nur die relevanten Vorgänge und Eigenschaften präsentiert werden. Wenn wir Ihre externe Technische Dokumentation erstellen, wird sie die Qualität vermitteln, die Ihr Produkt bereits hat!

In jedem Fall legen wir Wert darauf, dass alle Unterlagen und Beschreibungen möglichst leicht zu warten sind. Auf diese Weise werden bei Änderungen und Weiterentwicklungen Ihres Produktes die Kosten für die Pflege der Technischen Dokumentation im Zaum gehalten.

Sollten Sie uns beauftragen, prüft einer unserer Technischen Redakteure zuerst die vorhandene Technische Dokumentation inklusive Risikobeurteilung, Zeichnungen sowie Zuliefererdokumenten. Danach erhalten Sie von uns ein detailliertes Angebot zur Erstellung oder Überarbeitung Ihrer Technischen Dokumentation. Es bleibt Ihnen überlassen, ob Sie sich für die kostengünstige, aber vollständige oder für die aufwendige, jedoch besonders wertige Variante entscheiden.

Maschinenrichtlinie & Co: Wegweiser im Regeldschungel

Die wesentlichen Anforderungen an Inhalt und Umfang von Technischen Dokumentationen stehen in der seit zehn Jahren gültigen Europäischen Maschinenrichtlinie (2006/42/EG). Demnach muss einer sogenannten vollständigen Maschine, die über mindestens ein bewegliches Teil verfügt und mit anderer als der menschlichen Kraft bewegt wird, eine Betriebsanleitung beigefügt sein. Außerdem darf sie in der Europäischen Union nur mit einer Konformitätserklärung in Verkehr gebracht werden.

Darüber hinaus definiert die Maschinenrichtlinie sogenannte unvollständige Maschinen. Diese können für sich genommen keine bestimmte Funktion erfüllen. Sie sind dazu bestimmt, mit anderen unvollständigen Maschinen zusammengefügt oder in eine vollständige Maschine eingebaut zu werden. Unvollständige Maschinen dürfen hierzulande nur mit einer Montageanleitung und einer Einbauerklärung verbreitet werden.

Wenn Sie Ihre Technische Dokumentation uns überlassen, reduzieren Sie effektiv Ihr Produkthaftungsrisiko! Wir erstellen Ihre Betriebs- bzw. Montageanleitung für vollständige und unvollständige Maschinen nach den Vorgaben der Maschinenrichtlinie. Die Struktur der Instruktionen folgt den Standards der DIN EN 82079. Natürlich enthalten unsere Betriebsanleitungen Sicherheitshinweise nach der SAFE-Struktur: Auf das Signalwort, folgt die Art der Gefahr, die mögliche Folge der Gefährdungssituation sowie ein Hinweis, wie der Gefahr zu entkommen ist. Sicherheitszeichen und -farben verwenden wir nach den Vorgaben der DIN ISO 3864.

Daneben haben wir langjährige Erfahrung bei der Erstellung von Technischen Dokumentationen für Anlagen und Gebäude nach Betriebsmittel- oder Dokumentationsvorschriften. Ihre Mitarbeiter haben alle Hände voll zu tun, um das Projekt erfolgreich abzuschließen. Der Kunde verlangt aber pünktlich eine umfangreiche Technische Dokumentation nach seinen Regeln? Kein Problem für uns. Wir setzen die Wünsche Ihrer Kunden um, ohne Ihnen Goldene Wasserhähne in Rechnung zu stellen. Oft lassen sich derartige Dokumentationsaufgaben teilautomatisieren, so dass wir mit unserer Erfahrung gegenüber Ihren Inhouse-Lösungen Geld und Zeit sparen können. Auf jeden Fall bleiben Sie jederzeit informiert über den Stand Ihrer Technischen Dokumentation. So sind Sie in der Lage gegenzusteuern, wenn Umfang und Kosten aus dem Ruder laufen.

Risikobeurteilung: Haftung vermeiden

Risikobeurteilung: Haftung vermeiden

Die Risikobeurteilung ist für die Technische Dokumentation unverzichtbar. Sie sollte gemäß der Maschinenrichtlinie bereits Teil der Konzeption und Entwicklung einer Maschine sein. Auf diese Weise können Gefährdungen, die vom Produkt ausgehen, identifiziert werden. Mit Designanpassungen des Produktes lassen sich die entdeckten Gefährdungen dann so weit wie möglich eliminieren. Am Ende des Entwicklungsprozesses benennt die Risikobeurteilung die nicht konstruktiv auszuschließenden Restgefahren. Vor diesen Restgefahren muss die Betriebsanleitung warnen. Eine Risikobeurteilung ist selbstverständlich auch für solche Produkte erforderlich, die außerhalb der Europäischen Union entwickelt wurden. In diesem Fall muss der Inverkehrbringer die Erstellung der Risikobeurteilung selbst in die Hand nehmen.

Wenn sie möchten, hilft Ihnen das Konstruktionsbüro von LinoPro dabei, eine Risikobeurteilung nach DIN EN ISO 12100:2010 zu erarbeiten. Dabei verwenden wir ein standardisiertes Verfahren, um alle geforderten Aspekte zu berücksichtigen. Wir stellen die richtigen Fragen – Ihre Entwicklungsingenieure müssen diese nur noch beantworten. Wir kümmern uns um die Dokumentation der Risikobeurteilung einschließlich der Einhaltung der etablierten Terminologie. Die Risikobeurteilung bleibt über den gesamten Lebenszyklus Ihres Produktes Bestandteil der internen Technischen Dokumentation.

CE-Kennzeichnung

CE-Kennzeichnung

Es gibt kaum ein Alltagsprodukt, bei dem man nicht auf das CE-Kennzeichen stößt. Ein Hersteller, der es vergibt, erklärt, dass sein Produkt „mit den Harmonisierungsrechtsvorschriften der [Europäischen] Gemeinschaft übereinstimmt“ (EU-Verordnung 765/2008). Er muss also alle sein Produkt betreffenden europäischen Richtlinien und Verordnungen sowie am besten auch (erleichtert den Prozess der Konformitätsbewertung!) die harmonisierten Normen beachten. Als harmonisierte Normen werden solche Standards bezeichnet, die im Auftrag der europäischen Kommission erarbeitet wurden. Dies trifft auf viele, jedoch nicht alle EN-Normen zu. Die CE-Kennzeichnung ist für die allermeisten in der EU in Verkehr gebrachten Produkte Pflicht. Sie gehört zum Standard-Repertoire der Technischen Dokumentation.

Die CE-Kennzeichnung wird nach Abschluss des Konformitätsbewertungsverfahrens auf dem Produkt angebracht. Wie die Konformitätsbewertung auszusehen hat, ist in mehreren EG- bzw. EU-Richtlinien geregelt: allen voran in der Maschinenrichtlinie 2006/42/EG. Darüber hinaus u.a. in der Niederspannungsrichtlinie 2014/35/EU und der EMV-Richtlinie 2014/30/EU. Die EU-Mitgliedsstaaten müssen die europäischen Richtlinien in nationale Gesetze überführen. Dazu gehören in Deutschland beispielsweise das Produktsicherheitsgesetz (ProdSG) und die Maschinenverordnung (9. ProdSV). Unsere Experten für die Technische Dokumentation führen Sie durch den Regelungsdschungel. Gemeinsam mit Ihnen erarbeiten wir anhand unserer branchenspezifischen Checklisten, welche Rechtsvorschriften Sie in Ihrem Konformitätsbewertungsverfahren beachten müssen. Als Experte für Ihr Produkt treffen Sie die letzte Entscheidung, welche Regelung für Sie gilt.

Am Ende des Konformitätsbewertungsverfahrens erstellt unser Konstruktionsbüro für Sie die Konformitätserklärung. Kontaktieren Sie uns frühzeitig in Ihrem Produktentwicklungsprozess, um ein teures Re-Design wegen der Nichtbeachtung einzelner Vorschriften zu vermeiden! Die CE-Kennzeichnung benötigen übrigens auch Produkte, die im Ausland entwickelt wurden. Fehlt für solche Produkte die Konformitätsbewertung, ist die Technische Dokumentation unvollständig. Derjenige, der das Produkt in der Europäischen Union (ggf. auch unentgeltlich!) verbreitet, ist dafür verantwortlich, die Konformitätsbewertung nachzuholen.

Unvollständige Maschinen erhalten übrigens keine CE-Kennzeichnung. Statt einer Konformitätserklärung ist für diese eine Einbauerklärung zu erstellen. Auch die Vergabe der Einbauerklärung setzt die Einhaltung von Regeln zur Auslegung, Konstruktion und Dokumentation voraus, zu denen wir Sie sehr gern beraten.

Multi-Channel Publishing

Multi-Channel Publishing

Bei uns müssen Sie sich nicht für alle Ewigkeit festlegen, in welchem Format Sie Ihre Technische Dokumentation veröffentlichen wollen: Mithilfe von Autorensystemen, die Layout und Inhalt trennen, kann die gleiche Betriebsanleitung heute als PDF-Datei und morgen als Website ausgegeben werden. Die Zusatzaufwände für die Veröffentlichung in einem anderen Medium sind sehr gering.

Wir bieten Ihnen an, Ihre Dokumente zukunftssicher in InDesign oder Framemaker zu entwickeln. Diese Programme haben Standards im Desktop-Publishing gesetzt. Damit erstellte Dokumente sind leicht zu warten und mit geringem Aufwand zu übersetzen. Auf Wunsch kreieren wir auch LaTeX-Dokumente oder bauen ein Tutorial direkt in HTML5. Und wenn Sie darauf bestehen, erstellen wir Ihre Technische Dokumentation natürlich in MS Word, MS Publisher oder einem weiteren Programm Ihrer Wahl.

Dokumentationsanalyse

Sie haben bereits eine Betriebsanleitung, Montageanleitung oder Risikobeurteilung – wissen aber nicht, ob sie den geltenden Standards entspricht? Wir prüfen Ihre vorhandene Technische Dokumentation auf Herz und Nieren, d.h.

  • Entspricht sie den gesetzlichen Vorschriften und ist sie vollständig?
  • Entspricht sie der Norm für Gebrauchsanweisungen DIN EN 82079?
  • Sind Detailierungsgrad und Sprachniveau auf die Zielgruppe zugeschnitten?
  • Wurde in der Technischen Dokumentation eine konsistente und eindeutige Terminologie verwendet?
  • Verbessern Gestaltung, Aufbau und Platzierung der technischen Illustrationen die Aussagekraft der Anleitungen?
  • Sind Format und Formulierung dergestalt, dass die Übersetzungskosten möglichst niedrig gehalten werden?

Wir geben Ihnen Empfehlungen, wie Sie Ihre Technische Dokumentation verbessern können. Auf Wunsch unterbreiten wir Ihnen ein Angebot, wie wir Ihre vorhandene Technische Dokumentation auf Vordermann bringen können.

Technische Übersetzungen

Technische Übersetzungen

Wir arbeiten mit staatlich geprüften Übersetzern zusammen. Bei uns erhalten Sie Ihre Technische Dokumentation deshalb in einer EU-Amtssprache Ihrer Wahl. Natürlich nutzen die von uns beauftragten Übersetzer Translation-Memory und Terminologiemanagement-Werkzeuge, um effizient konsistente Übersetzungen abzuliefern.

Dokumentationsautomatisierung

Dokumentationsautomatisierung

Sie stellen viele ähnliche Produkte mit leichten Variationen her, wandeln also dieselbe Technische Dokumentation immer nur leicht ab? Jede Technische Dokumentation ähnelt sich in Grundzügen, da Sie jeweils nur technische Daten, Zeichnungen oder einzelne Formulierungen austauschen? Sie haben einen standardisierten Prüfprozess, ergänzen die Protokolle jedoch per Hand oder in einer Excel-Tabelle? Dann lassen Sie sich von den Lösungen unseres Konstruktionsbüros zur Dokumentationsautomatisierung überzeugen! Es ist teuer und fehleranfällig, immer und immer wieder eine ähnliche Betriebsanleitung nach der anderen herzustellen. Sofern die Ausgangsdaten in maschinenlesbarer Form vorhanden sind, schreibt sich solch eine individualisierte Technische Dokumentation per Knopfdruck. Auch wenn sich nur ein Teil der variablen Informationen automatisiert erfassen lässt: In der Regel bringt die Automatisierung der Technischen Dokumentation mittelfristig einen messbaren Zeit- und Geldvorteil.

Auch bei der Erstellung umfangreicher Anlagendokumentationen lässt sich durch die Teilautomatisierung der Technischen Dokumentation üblicherweise Zeit und Geld einsparen. Die Anwendungsmöglichkeiten reichen von der automatisierten Erstellung von Deckblättern und Verzeichnissen bis hin zur intelligenten Suche. Gerade in länger andauernden Projekten sammeln sich mit der Zeit Unmengen an Dokumenten an. Wenn auch der Projektleiter sich darin nicht mehr zurechtfindet, fragen Sie uns: Häufig ist der rote Faden in Metadaten, Anlagenkennzeichen und Typenbezeichnungen versteckt. Wenn wir Ihre Technische Dokumentation anhand dieser Daten sinnvoll ordnen, kann sie doch noch termingerecht übergeben werden!

Vielleicht benötigt auch Ihre ganze Dokumentationsinfrastruktur eine Renovierung. Wenn die CAD-Anwendung nicht mit dem PLM-System redet und dieses nicht mit Ihrem Autorensystem, gibt es in Ihrem Unternehmen eventuell noch zu viel fehleranfällige und teure Handarbeit. Fragen Sie das Konstruktionsbüro von LinoPro, wie Sie Ihre Prozesse verschlanken und beschleunigen können!

Beratung

Haben Sie Fragen?

Wollen Sie mehr erfahren oder benötigen Sie einen fachkundigen Rat zu Ihrer Dokumentationsaufgabe? Wir helfen Ihnen von Anfang an.

René Luhde
Tel: +49 351 444111 01
Mail: r.luhde@linopro.de