FAQ

Hier geben wir Antworten auf die Fragen, die im Zusammenhang mit den wichtigsten Themen rund um die Technische Dokumentation, Redaktion und Illustration auftreten:

Technische Dokumentation

Kosten entstehen in der Dokumentation an verschiedenen Stellen:

  • Kosten sparen bei der Informationsrecherche
  • Kosten sparen beim Texten und Grafikerstellen
  • Kosten sparen bei der Verwaltung
  • Kosten sparen beim Publizieren, Layouten
  • Kosten sparen beim Übersetzen

In jedem Bereich lassen sich Kosten sparen. Wenn die Bereiche optimal aufeinander abgestimmt sind, ist der Sparerfolg am größten!

Bei der Informationsrecherche geht viel Zeit verloren, wenn bei der Produktentwicklung nicht an die Informationsbedürfnisse der Redakteure gedacht wird. Die Dokumentation muss in den Entwicklungsprozess integriert werden und alle notwendigen Informationen automatisch erhalten. Stellen Sie hierzu eine Liste auf, welche Informationen die Redaktion benötigt. Definieren Sie, wer für die Lieferung der jeweiligen Info verantwortlich ist und legen Sie fest, bis wann im Entwicklungsprozess diese Informationen geliefert werden müssen. Hilfe für solche Festlegungen finden Sie zumeist in der QM-Abteilung.

Beim Texten muss systematisch gearbeitet werden. Technische Dokumentation muss modular aufgebaut sein, d. h. aus Modulen bestehen, die in unterschiedlichen Dokumentationen wieder verwendet werden können Dabei darf nicht jeder Redakteur seinen eigenen Stil und seine eigene Modularisierungsweise entwickeln. Einheitlichkeit ist hier notwendig. Dies geht am besten methodisch, siehe https://arakanga.de/arawiki/strukturierungsmethoden/.

Bei der Grafikerstellung kann vielfach auf 3d_Daten aus der Konstruktion zurückgegriffen werden. Mit der richtigen Software lassen sich aus diesen Daten alle Grafiken schnell erstellen, die in der Technischen Dokumentation benötigt werden, siehe https://arakanga.de/technische-dokumentation/technische-dokumentation/toolumgebungen/.

Die Verwaltung von Dokumentationen erfolgt vielfach auf dem Dateisystem, teilweise ergänzt mit einer Excel-Tabelle. Dies ist aufwendig, umständlich und fehlerträchtig. Stand der Technik ist für die Technische Dokumentation ein spezialisiertes Redaktionssystem zu nutzen, sogenannte CMS oder CCMS System, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.

Publizieren und Layouten sind die letzten Schritte im Erstellungsprozess. Hier kommen die Module zusammen und werden zu einer kompletten Dokumentation aufbereitet. Sind das z. B. Word Dokumente, kommt es oft zu unerwünschten Effekten, wenn Dokumente zusammenkopiert werden. Beim Maschinenbau müssen oft für die Zulieferdokumente Inhaltsverzeichnisse erstellt werden, zumeist manuell. Für diese Schritte ist Zeit erforderlich, die mit den richtigen Werkzeugen gar nicht oder nur in sehr geringem Maß notwendig sind. Redaktionssystem können diese Aufgaben automatisieren und „auf Knopfdruck“ das gewünschte Ergebnis erstellen, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.

Beim Übersetzen gibt es verschiedene Stellschrauben, an denen gedreht werden kann:

  • Vereinheitlichter, standardisierter Text
  • Modularisierte Texte
  • Einheitliche Terminologie
  • Auswahl des richtigen Übersetzungspartners

Wenn die Texte standardisiert sind und eine einheitliche Terminologie genutzt werden, ist die optimale Voraussetzung geschaffen, um über den Einsatz der richtigen Tools die Übersetzungskosten zu reduzieren.

  • Translation Memory Tools (TM), damit einmal übersetzte Texte automatisch und ohne Kosten wiederverwendet werden.
  • MT (Machine Translation), angekoppelt an das TM, um die Übersetzer zu entlasten und den gesamten Prozess deutlich zu beschleunigen.

Übersetzung und Terminologie

Um Übersetzungskosten zu reduzieren, haben wir folgende Ansatzpunkte:

Liegen die deutschen Texte fertig zur Übersetzung vor, so können wir den Übersetzungsprozess so einrichten, dass Sie bei der Übersetzung mit einem Translation Memory System für 100%-Matches – die bereits vorher übersetzten Texte – nichts mehr bezahlen müssen. Ohne Einbußen bei der Qualität der Übersetzung.

Bei großem Umfang der Dokumente und vielen Sprachen kann es sich außerdem rechnen, die deutschen Texte im Hinblick auf die Übersetzung zu überarbeiten. Folgendes können wir in diesem Fall tun:

  • Textumfang reduzieren – selbstverständlich bei gleichbleibendem Inhalt
  • Text modularisieren und Textbausteine wiederverwenden
  • Texte bearbeiten, sodass sie einfach zu übersetzen sind
  • Terminologie systematisieren

Dann ist es an der Zeit, mit der Terminologiearbeit zu beginnen. Wir können Sie dabei folgendermaßen unterstützen:

  • Argumente für die interne Überzeugungsarbeit liefern
  • den Prozess definieren und Sie bei der internen Umsetzung unterstützen
  • die passenden Tools einrichten und zur Verfügung stellen
  • im Rahmen von Übersetzungsprojekten Terminologiepflege übernehmen

Wir kürzen die Dokumente bei gleichem Inhalt um mindestens 30%, im Einzelfall auch um mehr. Wie das geht? Nun:

  • Informationen 100%-ig an Zielgruppe und Zweck des Dokuments anpassen, überflüssige Information aussortieren
  • jede Information – wirklich jede – auf Notwendigkeit hinterfragen, auch Sicherheitshinweise
  • knappe Formulierung wählen, Informationen insbesondere tabellarisch und in Listen aufbereiten
  • mehr Informationen durch Illustrationen ausdrücken

Ergebnis dieses Konzepts:

  • höhere Anwenderakzeptanz
  • niedrigere Übersetzungskosten
  • niedrigere Produktionskosten
  • schnellere Bearbeitung

Wir überprüfen Ihre Texte und liefern Ihnen im Prüfbericht eine Vorgabe für die Umsetzung.

Und sollten Ihre Texte komplett neu aufzusetzen sein – mit ARAKonzept würden wir Ihnen Folgendes vorschlagen:

  • Textumfang reduzieren – selbstverständlich bei gleichbleibendem Inhalt
  • Modularisieren des Textes und Wiederverwenden der Textbausteine
  • Texte bearbeiten, sodass sie einfach zu übersetzen sind
  • Grafiken sinnvoll textfrei gestalten
  • Terminologie sytematisieren

MT steht für Machine Translation (Maschinelle Übersetzung) also Computergestützte Übersetzung. Viele Jahre galt, das die Qualität von MT nur für interne Zwecke zu gebrauchen ist. Hier hat sich aber in den letzten Jahren durch den Einsatz neuronaler Netze viel getan. MT ist noch weit davon entfernt, perfekt zu sein. Für bestimmte Textsorten kann MT aber als Teil eines Prozesses mit Übersetzern sinnvoll und sehr kostensparend genutzt werden. Gut strukturierte Technische Dokumentation mit klarer Terminologievorgabe kann ein solcher Fall sein, siehe https://arakanga.de/arawiki/strukturierungsmethoden/


Redaktionssysteme

Redaktionssysteme sind teuer und rechnen sich doch nie – ist eine Meinung, die uns immer wieder begegnet ist. Tatsächlich ist das Gegenteil der Fall! Ohne Redaktionssystem, mit Word, FrameMaker oder InDesign, wird die Dokumentation so richtig teuer – nur der Einstieg ist billig. Redaktionssysteme sind auf Modularisierung, Wiederverwendung, Variantensteuerung, Übersetzungen und automatisches Publizieren ausgelegt. Das sind Funktionen, die eigentlich jeder Hersteller erklärungsbedürftiger Produkte zwingend benötigt. Ohne Redaktionssystem werden immer wieder Hilfsmitte wie Excel genutzt, um die Verwaltung halbwegs zu realisieren. Effizient ist dies zumeist nicht, siehe https://arakanga.de/arawiki/redaktionssysteme-dms/.


Content Delivery Portal

Antwort


Normen und Richtlinien

Wir überprüfen Ihre Betriebsanleitungen und liefern Ihnen im Prüfbericht eine Vorgabe für die Umsetzung.

Sollte Ihre Betriebsanleitung komplett neu aufzusetzen sein – mit ARAKonzept können wir Ihnen Folgendes zur Verfügung stellen:

  • eine an der Maschinerichtlinie und der ANSI Z535.6 orientierte Struktur der Betriebsanleitung
  • diverse Muster für die konkrete Umsetzung der Betriebsanleitung
  • Muster für strukturierte Sicherheitshinweise nach ANSI Z535.6
  • eine Systematik für die Dokumentation der Beziehungen zwischen Risikobeurteilung und Sicherheitsinformationen

Die DIN EN ISO 20607 ist eine harmonisierte Sicherheitsgrundnorm, deren Einhaltung für den Maschinenbau zwingend ist. Normen sind zwar normalerweise nicht zwingend, diese Norm spezifiziert aber die Anforderungen der Maschinenrichtlinie 2006/42/EG aus. Die Anwendung kann daher als zwingend angesehen werden, siehe https://www.beuth.de/de/norm/din-en-iso-20607/305722049.


Datenschutz
Wir, ARAKANGA GmbH (Firmensitz: Deutschland), verarbeiten zum Betrieb dieser Website personenbezogene Daten nur im technisch unbedingt notwendigen Umfang. Alle Details dazu in unserer Datenschutzerklärung.
Datenschutz
Wir, ARAKANGA GmbH (Firmensitz: Deutschland), verarbeiten zum Betrieb dieser Website personenbezogene Daten nur im technisch unbedingt notwendigen Umfang. Alle Details dazu in unserer Datenschutzerklärung.