Redaktionssysteme und Tools 

Warum brauche ich ein anderes Werkzeug als MS Word?

Man kann mit MS Word strukturiert arbeiten, aber wird vom Tool dabei nicht unterstützt. Für größere Dokumente voller Querverweise und mit generierten Verzeichnissen ist Word auch zu instabil. Die Modularisierung und Wiederverwendung ist kompliziert und fehlerträchtig, Layout-Änderungen ein Alptraum. Die Investitionen in Tools, die speziell für die Technische Dokumentation entwickelt wurden, lohnt sich auf jeden Fall.

Muss ich ein Redaktionssystem anschaffen, um effizient arbeiten zu können?

Nein, es kommt – wie immer – darauf an. Wie komplex sind Ihre Dokumente, wie viele Personen sind beteiligt, wie werden Übersetzungen abgewickelt, übernehmen Sie Daten aus anderen Systemen … diese und viele andere Fragen spielen eine Rolle bei der Entscheidung.

Welches Redaktionssystem ist das beste?

Auch hier gibt es keine Antwort, die für alle Anwender zutrifft. Im Beratungsprozess vergleichen wir Ihre Anforderungen mit den Möglichkeiten, die unterschiedliche Systeme bieten und unterstützen Sie bei der Auswahl des für Sie am besten geeigneten Systems.

Schulungen | Workshops | Training on the job

Wo können Schulungen | Workshops stattfinden?

Im Schulungsraum von A2 documentation & translation oder je nach Art der Veranstaltung direkt in den Räumen des Auftraggebers.

Um welche Uhrzeit beginnen und enden Schulungen?

Kurstage beginnen in der Regel um 9:00 Uhr und enden um 16:00 Uhr.

Welche Teilnehmeranzahl ist für Schulungen Workshops sinnvoll?

Bei reinen Theorieveranstaltungen sollte die Teilnehmeranzahl 12 nicht übersteigen. Für Veranstaltungen mit praktischem Anteil empfehlen wir, die Teilnehmeranzahl auf max. 6 zu beschränken.

Ist es möglich, auf spezielle Bedürfnisse angepasste Workshops und Schulungen zu buchen?

Workshops oder Schulungen können jederzeit individuell der Kunden- oder Projektanforderung angepasst werden.

Kann ich vor einem Kurs mit dem Trainer sprechen?

Für speziell zugeschnittene Veranstaltungen gehört die genaue Aufnahme des Bedarfs und Planung der Durchführung durch den Dozenten zum Umfang der Leistungen. Bei allgemein ausgeschriebenen Veranstaltungen ist dies nicht üblich.

Welchen Vorteil bieten Moderationen im Bereich der Technischen Dokumentation?

Oft wird erst durch den Blick von außen und im Gespräch der Vertreter unterschiedlicher Fachabteilungen Optimierungspotenzial aufgedeckt.
Im Rahmen einer Moderation vor Ort stellt ein Experte aus dem Bereich Normen/Richtlinien, Redaktionssysteme und/oder Technische Dokumentation Fragen zum Ist-Zustand. Ziel ist es, aus der entstehenden Diskussion Verbesserungsvorschläge zu ermitteln, die auch zum Teil sofort umgesetzt werden können …

Sprache

Welche Vorteile ergeben sich durch das Regelbasierte Schreiben?

Die konsequente Umsetzung von Schreibregeln erhöht vor allem die Qualität der Dokumentation. Neben einem einheitlichen „Look and Feel“ der Informationsprodukte ergeben sich Vorteile in Bezug auf die Wiederverwendung von Textmodulen (Stichwort: Single-Source-Publishing) sowie erhebliche Kostenersparnisse bei der Übersetzung von Dokumenten in andere Sprachen.

Grafik

Wie erzielt man Einheitlichkeit bei der Erstellung von Grafiken?

Ein einheitliches „Look and Feel“ bei der Erstellung von Grafiken erreicht man durch die konsequente Umsetzung von Gestaltgesetzen. Diese haben sich in den Bereichen Typografie und Layout längst bewährt und eignen sich sehr gut für die systematische Konzeption und Erstellung von Grafiken.

Angebote

Mit welchen Kosten muss ich rechnen?

Das kann man nur projektbezogen abschätzen. Unser Ziel ist aber, dass der Aufwand Ihrem Produkt angemessen ist.

Welche Informationen sind erforderlich, um Angebote in der Technischen Dokumentation zu erstellen?

Die Angebotserstellung kann auf Grundlage von Testgeräten, Maschinen-/Anlagenbesichtigung, Vorgängerdokumentation, Bildern und Grafiken, Entwicklungsplänen, Pflichten-/Lastenheften, Entwicklungsdokumentation, usw. erfolgen.

Wie wird der Umgang mit vertraulichen Unterlagen gehandhabt?

Datenschutz und – sicherheit hat oberste Priorität. Daher werden alle erforderlichen Maßnahmen unternommen, um eine maximale Absicherung zu gewährleisten. Dies kann selbstverständlich mit einer Vertraulichkeitsvereinbarung schriftlich bestätigt werden.

Ist ein Einsatz vor Ort möglich?

Wenn es das Projekt erfordert, ist eine Tätigkeit vor Ort selbstverständlich möglich. Je nach Komplexität des Projektes müssen Zeiten beim Auftraggeber für Initiierungsphasen eingeplant werden. Ein Einsatz über die gesamte Dauer des Projektes ist eher die Ausnahme, in speziellen Fällen aber ebenfalls notwendig.

Ist ein Termin vor Ort zur Erfassung der Aufgabenstellung kostenfrei?

Ein unverbindlicher „Kennenlernbesuch“ im Raum D/A/CH ist für eine erste Einschätzung (Projekt, Unternehmen, Ansprechpartner) für alle Beteiligten sehr hilfreich und wird nicht berechnet.

Können Angebote zu einem Festpreis erstellt werden?

Sofern der Aufwand auf Basis ausreichend zur Verfügung gestellter aussagekräftiger Informationen abzuschätzen ist, kann ein Festpreis-Angebot erstellt werden.

Redaktionsleitfaden und Prozesse

Was ist ein Redaktionsleitfaden?

Der Redaktionsleitfaden beschreibt die Prozesse und Vorgehensweisen, die für die Erstellung der Technischen Dokumentation in einem Unternehmen gelten. Auch Vorgaben zu Tools, Layout, Template und Gestaltung von Grafiken sowie Vorgaben bei der Arbeit mit einem Redaktionssystem werden hier dokumentiert.

Wie umfangreich muss ein Redaktionsleitfaden sein?

Das kommt auf das Unternehmen und die zu erstellenden Dokumentationen an. Wird ein Redaktionssystem eingesetzt, sind neben Prozessen und Gestaltungsvorgaben auch die Vorgaben zur Modularisierung zu beschreiben. Der Redaktionsleitfaden wird damit umfangreicher. Generell sollte er aber nicht überfrachtet werden und nur so viel vorgeben, dass die Erstellung technisch korrekter und einheitlich gestalteter Dokumentationen gewährleistet wird. Nur dann wird er insbesondere auch von externen Abteilungen, die Beiträge zur Dokumentation und zum Review liefern sollen auch akzeptiert.

Nach welchen Prozessen arbeitet A2 documentation & translation?

A2 documentation & translation ist zertifiziert nach DIN EN ISO 9001 und verfügt über ein eigenes Qualitätsmanagementsystem. Dieses findet bei allen internen und externen Projekten Anwendung. Wünscht der Kunde ein Vorgehen nach seinen eigenen Qualitätsstandards wird dies umgesetzt. Der Kundenprozess wird dann in einer A2‐Arbeitsanweisung abgebildet.

Welche Möglichkeiten gibt es staatliche Förderungen im Bereich Technische Dokumentation zu erhalten?

Die jeweiligen Fördermöglichkeiten müssen im Einzelfall geprüft werden.
Anträge für Förderungen bei staatlichen Projektträgern müssen bestimmte Kriterien erfüllen. Experten bei A2 haben hiermit umfassende Erfahrung und können das Schreiben des Antrags und die Erstellung einer Projektbeschreibung übernehmen. Die Abrechnung erfolgt unabhängig vom Antragserfolg auf Stundenbasis und nicht wie bei vielen anderen Beratern nur im Erfolgsfall, aber anteilig an der Fördersumme. Die Kosten bleiben überschaubar.

EG-Konformitätsbewertungsverfahren

Welche wesentlichen Schritte sind im Rahmen des EG-Konformitätsbewertungsverfahrens erforderlich?

  • Definition der bestimmungsgemäßen Verwendung des Produktes
  • Ermittlung der relevanten EG-Richtlinien und der entsprechenden konkretisierten Normen
  • Ermittlung der Anforderungen und Bedingungen an Ihr Produkt
  • Muss eine sogenannte „benannte Stelle“ in das Konformitätsbewertungsverfahren einbezogen werden (Pflicht ist in den Richtlinien festgelegt – In der Regel bei Produkten mit hohen Risiken)
  • Überprüfung der Konformität Ihres Produktes hinsichtlich den Anforderungen aus Richtlinien und Normen
  • Erstellung der Technischen Dokumentation (Intern / Extern), inklusive Konformitätserklärung
  • Übersetzung der Externen Dokumentation, im Falle der Verwendung des Produktes in einem EU-Mitgliedstaat, in die jeweilige Amtssprache.
  • CE-Kennzeichnung – gut lesbar und dauerhaft angebracht• Anschließend nicht vergessen: Produktbeobachtungspflicht!

Welche Unterlagen müssen dem Betreiber vor der Inbetriebnahme einer vollständigen Maschine vorliegen?

Die Konformitätserklärung und Betriebsanleitung oder sonstige für den Benutzer relevanten Informationen (sofern diese nicht Teil der Betriebsanleitung sind) in der Erstellungssprache sowie die übersetzten Versionen in der Amtssprache des Verwendungslandes.

Wann handelt ein Verantwortlicher grob fahrlässig?

Die Wahrscheinlichkeit wenn er „NICHTS“ tut ist wesentlich höher, als wenn er „ETWAS“ tut, dabei aber Fehler macht. Wichtig: Entscheidungen müssen dokumentiert werden.

Was ist eine unvollständige Maschine?

Eine „unvollständige Maschine“ ist eine Gesamtheit, die fast eine Maschine bildet, für sich genommen aber keine bestimmte Funktion erfüllen kann. Ein Antriebssystem stellt eine unvollständige Maschine dar. Eine unvollständige Maschine ist nur dazu bestimmt, in andere Maschinen oder Ausrüstungen eingebaut oder mit ihnen zusammengefügt zu werden, um zusammen mit ihnen eine Maschine im Sinne dieser Richtlinie zu bilden.[Quelle: Maschinenrichtlinie 2006/95/EG Artikel 2 (g)]

Ist die Erstellung einer Risikobeurteilung im Maschinenbau verbindlich?

Der Hersteller einer Maschine oder sein Bevollmächtigter hat dafür zu sorgen, dass eine Risikobeurteilung vorgenommen wird, um die für die Maschine geltenden Sicherheits- und Gesundheitsschutzanforderungen zu ermitteln. Die Maschine muss dann unter Berücksichtigung der Ergebnisse der Risikobeurteilung konstruiert und gebaut werden." [Quelle: Maschinenrichtlinie 2006/95/EG Anhang I 1]