Normen und richtlinien technische dokumentation

Normen und richtlinien technische dokumentation

Vorlage für die Konformitätserklärung

Der Begriff technische Dokumentation (oder technisches Dossier) bezieht sich auf die Unterlagen, die ein Hersteller von Medizinprodukten vor dem Inverkehrbringen bei der Behörde einreichen muss. Das Ausfüllen der technischen Unterlagen ist ein unumgänglicher Schritt, um das Konformitätsbewertungs- oder Zulassungsverfahren zu bestehen. Daher ist es ein wichtiger erster Schritt auf dem Weg zur Zulassung aller Medizinprodukte.

Die Medizinprodukterichtlinie (im Gegensatz zur MDR) ist in Bezug auf die Anforderungen an diese Dokumente etwas unklar. Alle oben genannten Dokumente müssen vom Hersteller während des Konformitätsbewertungsverfahrens über die technische Dokumentation eingereicht werden.

Die Medizinprodukteverordnung (MDR) definiert nicht nur die Anforderungen an das Medizinprodukt (Anhang I), sondern auch die Anforderungen an die Dokumentation selbst (Anhang II). Diese muss enthalten (siehe Abb. 1):

Normen wie ISO 14971, IEC 62304, IEC 60601-1 und IEC 62366-1 bieten jedoch detailliertere Spezifikationen. In der ISO 62366-1 ist festgelegt, dass die Dokumentation die Planung einer formativen Bewertung enthalten muss. In der MDD, MDR oder ISO 13485 finden Sie keine derart detaillierten Anforderungen.

Was sind die Standards für die Dokumentation?

Dokumentationsstandard ist der Standard für die Qualität und Formatierung von Dokumenten, wie er in einem Auftrag angegeben ist. Alle erstellten Dokumente müssen mindestens den geltenden Industriestandards entsprechen oder diese übertreffen.

Was sind Normen für das technische Schreiben?

Ein Styleguide für das technische Schreiben informiert die technischen Redakteure über die Standardmarkensprache, den Tonfall, die Terminologie, die Abkürzungen, die Strukturierung der Dokumente und andere bewährte Schreibverfahren. Er enthält verschiedene Beispiele und Vorlagen für alle Arten von Inhalten.

Bewährte Verfahren der technischen Dokumentation

Technische Redakteure müssen in der Lage sein, das breite Spektrum an Aufgaben zu bewältigen, das mit der Erstellung eines Dokuments verbunden ist. Betriebsanleitungen müssen nicht nur verständlich sein, sie müssen auch leicht zugänglich sein, die sichere Verwendung des Produkts gewährleisten und schließlich auch noch ansprechend aussehen. Doch wo können sich technische Redakteure Unterstützung holen? Gute Anhaltspunkte bieten die Norm IEC/IEEE 82079-1.2019, der tekom-Leitfaden “Regelbasiertes Schreiben” oder die eher sicherheitsorientierte ANSI Z535.6. Was leisten diese Normen und wie helfen sie bei der Erstellung von Dokumenten?

  Dokumente scannen und bearbeiten kostenlos

Die Norm IEC/IEEE 82079-1 “Erstellung von Gebrauchsinformationen (Gebrauchsanweisungen) für Produkte” ist ein kurzer Allrounder für das technische Schreiben. Diese Norm behandelt mehrere relevante Punkte, mit denen sich jedes Team für technische Redaktion früher oder später auseinandersetzen muss. Sie geht auf drei Aspekte der Dokumentenerstellung näher ein: den Zweck, die Qualität und den Erstellungsprozess eines Informationsprodukts.

Diese Norm hilft Ihnen bei der Planung und Gestaltung Ihres Informationsmanagementprozesses und hilft Ihnen, sich an wichtige Fragen zu erinnern. Wichtige Inhalte für Produktinformationen sind ebenfalls aufgeführt. Je nach Produkt sind möglicherweise nicht alle davon zutreffend. Die Norm gibt auch Tipps zur Strukturierung und Organisation von Inhalten und zur Auswahl von Medien für das Informationsprodukt. In der neuen Ausgabe 2019 werden auch digitale Ausgabeformate behandelt und es wird nun auch auf die Fähigkeiten eingegangen, die ein technischer Redakteur mitbringen sollte.

Beispiel für eine technische Dokumentation

Laut Definition umfasst die technische Dokumentation alle Informationen, die vom Hersteller oder Vertreiber parallel zum Entstehungs- und Produktlebenszyklus eines technischen Produkts erstellt werden. Die Definition des Begriffs “technisches Produkt” deckt ein breites Spektrum ab. Er reicht von einem Stabmixer bis zu einem hochkomplexen Kraftwerk.

Die externe technische Dokumentation richtet sich an den Betreiber und Benutzer von Maschinen und Anlagen. Sie stellt sicher, dass das Produkt sicher und bestimmungsgemäß in Betrieb genommen, verwendet, gewartet und entsorgt wird. In der Regel ist ein technischer Redakteur für die externe Dokumentation verantwortlich. Sie wird auch in die Sprache des Benutzers übersetzt. Zu den häufigsten Formen der externen technischen Dokumentation gehören Installations- und Montageanleitungen, Gebrauchsanweisungen, Benutzerhandbücher, Serviceanleitungen und Tutorials.

  Indesign dokument größe ändern

Eine professionelle technische Dokumentation dient dazu, ein Unternehmen so weit wie möglich vor Schadenersatzansprüchen zu schützen. Wird ein Benutzer durch eine Maschine oder Anlage verletzt, kann der Hersteller im Idealfall auf die technische Dokumentation verweisen, die genaue Hinweise zur Vermeidung von Unfällen enthält. Ein weiterer Vorteil ist die Reduzierung von Reklamationen und Gewährleistungsansprüchen. Professionell erstellte technische Dokumentationen definieren genaue Verfahrensschritte für die Nutzung und helfen so, Fehlbedienungen zu vermeiden. Gut strukturierte Benutzerhandbücher reduzieren Supportanfragen und regen den Anwender zudem an, das Produkt mit all seinen Funktionen zu nutzen. Für den Hersteller ist eine fundierte, optimal informative technische Dokumentation auch ein unterstützendes Marketinginstrument, denn sie unterstreicht die Professionalität des Unternehmens und lässt den Kunden die Marke positiver wahrnehmen. Darüber hinaus sind zielgruppengerecht aufbereitete Informationen eine sinnvolle Unterstützung für Schulung und Vertrieb. Technische Dokumentationen können immer wieder verwendet werden, da sie durch ihre digitale Aufbereitung ständig angepasst und aktualisiert werden können.

Ce-Zertifikat und Konformitätserklärung

Nachdem der DOI zugewiesen wurde, registriert die Bibliothek ihn bei CrossRef und aktiviert den Hyperlink in der veröffentlichten Version des Manuskripts.    Die Version der Veröffentlichung mit dem aktiven DOI ist die “offizielle Version der Aufzeichnungen”.

Wichtiger Hinweis: Die Autoren haben 10 Tage Zeit, um kleinere redaktionelle Änderungen an den veröffentlichten PDF-Dateien zu beantragen. Nach Ablauf der 10 Tage müssen die Autoren die Änderungen in ein Errata-Update oder eine Revision einarbeiten und erhalten eine neue DOI für die Veröffentlichung.

  Konstanzprüfung dokumentation der prüfergebnisse

Überschriften sollten einzeilig in einer fetten Sans-Serif-Schriftart gesetzt werden. Der Fließtext sollte einzeilig in einer Serif-Schriftart geschrieben sein.  Mathematische oder chemische Ausdrücke können in größeren Schriftarten mit größerem Abstand geschrieben werden, um die Lesbarkeit des Textes zu verbessern.

Die Autoren sind dafür verantwortlich, ihre Manuskripte Korrektur zu lesen, Fehler zu berichtigen und sicherzustellen, dass ihre Manuskripte alle in diesen Anweisungen und den Vorlagen aufgeführten erforderlichen Bestandteile enthalten.

Gemäß ANSI/NISO Z39.18-2005 (R2010) Scientific and Technical Reports – Preparation, Presentation, and Preservation (5/13/2010) sollte Ihr Dokument je nach Bedarf die folgenden Bestandteile in der unten aufgeführten Reihenfolge enthalten:

Esta web utiliza cookies propias para su correcto funcionamiento. Al hacer clic en el botón Aceptar, acepta el uso de estas tecnologías y el procesamiento de tus datos para estos propósitos. Más información
Privacidad