Die Technische Dokumentation muss im digitalen Zeitalter beachten, dass immer weniger Leser sich eine komplette Anleitung durchlesen. Wir sind es aus unserem Alltag gewöhnt, Inhalte sofort und passend zu erhalten. Daher sind zielgruppengerechte und intelligent verknüpfte Informationen für die Technische Dokumentation essentiell.
OCR (Optical Character Recognition) ist eine Technologie, die es ermöglicht, unterschiedliche Dokumente, wie eingescannte PDFs in bearbeitbare, digitale Dateien umzuwandeln. Für die Technische Dokumentation bedeutet das, dass eingescannte Betriebsanleitungen digitalisiert werden können. Und das ohne langes Abtippen. Innerhalb weniger Minuten können Dokumente mittels OCR-Technologie (Texterkennung) in digitale Formate umgewandelt werden. Eine abschließende Rechtschreibprüfung sollte auf … Weiterlesen
Mittlerweile gibt es schon bestimmte use cases in denen Künstliche Intelligenz die Technische Redaktion unterstützt. Beispielsweise können modulare Inhalte mithilfe einer KI automatisch Metadaten zugeordnet werden. Auch das Finden von Dubletten, kann eine sinnvolle Unterstützung für uns Technische Redakteure sein.
Um eine gute Lieferantendokumentation zu erhalten, ist es wichtig, dass die Technische Redaktion mit dem Einkauf eine gute Zusammenarbeit sucht und diese aktiv unterstützt. Der Einkauf eines Unternehmens kennt oftmals die Problematik der Technischen Redaktion und Konstruktion nicht. Hier ist es angebracht, dass die Redaktion ihre Anforderungen an Lieferantendokumentationen erklärt und vermittelt. Dies kann sinnvollerweise … Weiterlesen
Im Internet findet man zahlreiche Beispiele von schlechten Anleitungen. Oft sind es Übersetzungsfehler, die uns zum Schmunzeln bringen. Auch kann es vorkommen, dass die gelieferte Anleitung nicht zum Produkt passt. Manche Anleitungen sind reine Funktionsbeschreibungen und haben keinerlei Handlungsanforderungen oder es fehlen komplette Kapitel auf die eigentlich verwiesen werden soll.
Besonders im Bereich einer Anlagendokumentation, wenn eine gelieferte Dokumentation in die gesamte Technische Dokumentation eingebunden werden muss, kann es zu Problemen kommen. Oft sind Dokumentationen vom Lieferanten unbrauchbar, haben keine Handlungsaufforderungen, keinen Wartungsplan oder ungeeignete Ausgabeformate. Auch die Lieferung in der falschen Sprache ist kein seltenes Phänomen.
Typischerweise werden von uns erstellte Dokumente nicht nur gedruckt, sondern in verschiedenen Online-Medien zur Verfügung gestellt. Beispiele dafür sind: Verlinkte PDFs auf DVD Integrierte Software-Hilfe Hilfe auf der Maschinensteuerung, über Touchscreen bedienbar Content Delivery System (CDS)
Natürlich kann man einfach drauflos schreiben, es führt aber schnell zum Chaos! Strukturierungsmethoden sind sozusagen die Anleitung für die Anleitung und besonders wichtig für jeden Technischen Redakteur. Ziel einer Strukturierungsmethode ist es, Technische Dokumentation systematisch und strukturiert zu erstellen. Man gliedert Informationen in sinnvolle Einheiten. Somit können Benutzer die gewünschte Information leichter finden und diese … Weiterlesen
Besondern für Unternehmen mit mehreren Technischen Redakteuren sind sprachliche Standards besonders relevant. Die Konsistenz in Wortwahl und Stil steigert die Textverständlichkeit, reduziert Übersetzungskosten und steigert somit die Qualität Ihrer Dokumentation. Die Regeln Ihrer Standardisierung halten Sie in einem Redaktionsleitfaden fest. Mehr Infos zum Redaktionsleitfaden findet Ihr hier: Redaktionsleitfaden · ARAKANGA GmbH
Im Grunde genommen bedeutet das: Illustrieren statt Beschreiben. Alle wichtigen Informationen werden über Bilder vermittelt. Oftmals sind sie aussagekräftiger als reiner Text. Sie senken Übersetzungskosten oder sie entfallen ganz. Noch interessanter kann die Informationsübermittlung in Form von bewegten Grafiken, Animationen oder Filmen erfolgen. Diese könnten bei Wartungs- und Instandsetzungsarbeiten am Interface einer Maschine abgerufen werden.