Technische Dokumentation für eine perfekte Informationsarchitektur

Nutzen soll eine Technische Dokumentation. So funktional soll sie sein wie ein Gropius-Bauhaus, nicht wie Neuschwanstein. Mit klaren Anweisungen, so kurz und prägnant wie nur möglich, soll der Anwender auch mit den kompliziertesten Produkten leichtes Spiel haben. Dazu sind Technischen Redakteuren alle Mittel recht: eine klare, verständliche Sprache, prägnante Bilder und Schritt-für-Schritt-Videos. Eine Vielzahl an Kompetenzen vieler Könner ist notwendig, damit eine Technische Dokumentation eine stimmige Informationsarchitektur hat. Meint der Anwender am Ende: „War ja echt easy“, dann war sie gut.

Technische Redaktion

Wenn sich die Löschtaste in nichts auflöst

Die viertwichtigste Erfindung in der Menschheitsgeschichte nach Feuer, Rad und Thermomix ist die Löschtaste. Um zu erahnen, wie viel sie uns erspart hat und ersparen könnte, reicht ein Blick in die sozialen Medien. In der Technischen Redaktion – aber auf welchem Rang sie wiederum steht, ist individuell recht unterschiedlich – sollte ihre Bedeutung ins bodenlose Nichts sinken. Formen die Stimmbänder des Lesers einer Anleitung nur ein einziges „Hä?“, geht das ja noch. Werden’s aber mehr, wird’s kritisch für den Content. Bedrohlich schwebt der Zeigefinger über „Entf“. Sie und wir wollen nicht, dass er sich senkt, der schlimme Finger. Content tötet. Wir retten Leben!

Wir liefern Ihnen todsichere Texte gemäß den neuesten Erkenntnissen aus der User-Experience-Forschung, eingängig, Hä-frei illustriert und haftungssicher. Das gilt für jedes Content-Format: Text, Bild, Animation, Audio und Video. Ihr Budget ist unsere Richtschnur. Qualität unser Versprechen.

Ihre Vorteile

  • Technische Dokumentationen in Premiumqualität 
  • Aufwertung Ihres Produkts durch optimale Benutzerführung und Kundenbewertungen 
  • Multimediale Aufbereitung als Text, Bild, Animation, Audio und Video gemäß Ihrem Budget 
  • Prozessorientierte Aufbereitung des Contents wie durch Modularisierung und Strukturierung des Inhalts nach Topics 
  • Haftungssichere Dokumente, da wir alle relevanten, aktuellen Normen wie zum Beispiel nach 82079, 26514, 20607, ANSI Z535.6 berücksichtigen 
  • Punktgenaue Umsetzung der neuesten Erkenntnisse aus dem User-Experience-Design (UXD) 

Unsere Leistungen

  • Konzeption, Gestaltung und Template-Entwicklung, zum Beispiel in Word, FrameMaker oder InDesign  
  • Dokumentationserstellung: normenkonform, benutzerfreundlich und kostenoptimiert nach aktuellem Stand der Technik 
  • Redaktion gemäß den aktuellsten Forschungserkenntnissen der Usability-Forschung 
  • Grafikerstellung und Medienintegration  
  • Modularisierung und Datenmigration in Ihre Redaktionssysteme 
  • Qualitätssicherung durch: 
    • Lektorat: Prüfung von Stil, Grammatik, Rechtschreibung und Inhalt 
    • Terminologie-Erfassung, -abstimmung und -pflege, auch per Tools 
  • Nachhaltige Redaktion: 
    • Formulierung eines Redaktionsleitfadens und Styleguides für zukünftige Dokumentationen 
  • Usability Tests:  
    • Expertenanalyse durch heuristische Evaluation 
    • Nutzerbefragung: Online-Umfragen, telefonische Befragung, persönliche Nutzerbefragung, Befragung von Fokusgruppen und Nutzertests im Usability-Labor 

Wir bearbeiten Ihre Aufträge mit den gängigsten Redaktionssystemen, DTP- und Grafikprogrammen. Zusätzlich nutzen wir auch unser itl Tool für die Autorenunterstützung [i]-match. Damit können wir Sie beim gesamten Redaktionsprozess unterstützen: bei der Erstellung von Dokumentationen, bei der Einführung von Tools und Systemen in Ihrem Haus, bei der Datenbereinigung in Ihren Systemen bis hin zum Feinlayout Ihrer Dokumente in den gewünschten Zielsprachen.

Folgende Tools werden bei itl eingesetzt:

  • Adobe InDesign 
  • Adobe FrameMaker 
  • Microsoft Word 
  • Adobe RoboHelp 
  • MadCap Flare 
  • etc. 
  • Adobe Illustrator 
  • Adobe Photoshop 
  • Corel DESIGNER 
  • 3DVia Composer 
  • Adobe Substance 3D 
  • SAP 3D Visual Enterprise Author 
  • etc. 
  • SCHEMA ST4 
  • docuglobe 
  • TIM 
  • Smart Media Creator 
  • Noxum Publishing Studio 
  • etc. 

Das sind unsere Angebote zur Qualitätssicherung bei Inhalt und Benutzerführung, wenn Konzeption und Technische Redaktion bereits erledigt sind: 

  • Lektorat: Prüfung von Stil, Grammatik, Rechtschreibung und Inhalt 
  • Terminologie: Terminologie-Erfassung, -abstimmung und -pflege, die auch mithilfe eines Tools erledigt werden können 
  • Regelwerk: Formulierung eines Redaktionsleitfadens und Styleguides für zukünftige Dokumentationen 
  • Usability Tests: 
    • Expertenanalyse: durch heuristische Evaluation 
    • Nutzerbefragung: Online-Umfragen, telefonische Befragung, persönliche Nutzerbefragung, Befragung von Fokusgruppen und Nutzertests im Usability-Labor 

UXD – Blogartikel

Erfahren Sie alles zu UXD im Blogartikel von Dieter Gust mit dem Titel "Die Zukunft ist heute und heißt UXD – User Experience Design"

Mehr

Der itl Newsletter

Melden Sie sich zu unserem Newsletter an und bleiben Sie up to date in Sachen Technische Dokumentation, Übersetzung, Software und Weiterbildung.

Videoproduktion

Videos und Animationen: … uund Action!

Ein Bewegtbild ohne Bewegung ist so sinnfrei wie ein Hörbuch ohne Ton. In Videos oder Animationsstreifen muss etwas passieren, und zwar mehr, als dass ein Mensch in eine Kamera spricht; es sei denn, die Botschaft ist die Stimme selbst. Kommt aber auch eher selten vor. Abläufe und Prozesse, fließend dargestellt, sind das Elixier für Filmisches, es geht also um vorgemachtes Handlungswissen. Richtig geskripted, ist es sogar völlig egal, welche Sprache im Video gesprochen wird. Denn dann sind die Vorgänge und Handlungen an sich idealerweise so selbsterklärend, dass das gesprochene Wort nicht notwendig ist. Wenn allerdings weder Ton noch Vorgänge relevant sind, reicht eine 2- oder 3-D-Animation. Die wiederum ist besser als ein Bild. Für jede Anwendungssituation gibt es die perfekte visuelle Lösung.

Wir setzen Ihre Montage-, Service- oder Bedienungssanleitungen in das am besten geeignete Bewegtbildkonzept um. Auch Lehrvideos für Produktschulungen oder Fertigungsanleitungen produzieren wir nach den neuesten UX-Kriterien.

Ihre Vorteile

  • Höhere Kundenzufriedenheit durch verständliche Anleitungen 
  • Entlastung Ihres Kundenservice 
  • Kompetente, multimediale Begleitung Ihres technischen Produkts 
  • Bestandteil Ihres Marketings auf Social-Media-Plattformen 
  • Bereicherung Ihres Online-Auftritts auch im Sinne von SEO 

Unsere Leistungen

  • Gesamtkonzept für Ihre Bewegtbildanleitungen auf Basis eines optimalen User-Experience-Designs
  • Umsetzung in Videos, 2- oder 3-D-Grafikanimationen
  • Vorproduktion inklusive Nutzungskonzept, Navigationsstruktur und Storyboard
  • Regie und Dreharbeiten inklusive redaktioneller Begleitung
  • Postproduktion: Schnitt, Vertonung und falls nötig Texteinblendung
  • HTML5 zur responsiven Ausgabe inklusive Videoplayer-Design
  • Usability-Tests, die am Ende der Entwicklung durchgeführt werden

Immer up to date: itl Blog

Alles Aktuelle in den Kategorien Technische Doku, Übersetzung, Prozessoptimierung, Terminologie und Unternehmen.

Mehr

Bildproduktion

Das Dreamteam der Kommunikation sind Text und Bild

„Ein Bild sagt mehr als tausend Worte“ – gut, aber versuchen Sie diesen einfachen Satz mal als Grafik darzustellen. Ein Text hat Grenzen, ein Bild auch. Beides zusammen aber ist ein Dreamteam. Der Mensch nimmt ein Bild um ein Vielfaches schneller wahr als einen Text. Wie viel schneller? Etwa 60.000 Mal. Das bedeutet, dass Sie mit dem Auto bei 60 km/h unglaubliche 90 Mal um die Erde düsen würden. Bilder sind also ein zum Text mindestens gleichwertiger Bestandteil Ihrer Technischen Dokumentationen, denn sie werden blitzschnell erfasst und verarbeitet. Visuelle Elemente sind bei bestimmten Themen das Mittel der Wahl, um Ihre Technische Dokumentation klarer und verständlicher zu machen.

Wir reichern Ihre Produktdokumentationen um funktionale visuelle Elemente an, damit Ihre Kunden Inhalte schneller und leichter erfassen können. Dabei steht eine Vielzahl an Möglichkeiten zur Verfügung, die sich durch eine jeweils spezifische Mechanik auszeichnen.

Die Auswahl bei visuellen Elementen: 

  • Technische Illustrationen 
  • Ersatzteil- und Explosionszeichnungen 
  • Foto-Strichumsetzungen 
  • Graustufen- und Farbgrafiken 
  • Schema- und Funktionsgrafiken 
  • Infografiken 
  • Schnitt- und Phantomzeichnungen 
  • 3D-Produktvisualisierungen 
  • Piktogramme 
  • Produktaufkleber, Warnschilder

Unsere Leistungen

  • Anfertigung von Grafiken auf Basis von 3D-CAD-Daten, Produktmustern oder Fotografien 
  • Erstellung von einzelnen Grafiken nach Kundenvorgaben 
  • Entwicklung des Designs und Erstellung aller Grafiken einer Dokumentation 
  • Dokumentation des Designs in einem Styleguide 

Ihre Vorteile

  • Bilder sind „Eyecatcher“ und ziehen den Blick unweigerlich auf sich  
  • Sie motivieren und lockern durch ihre Formen, Farben und den sie umgebenden Weißraum Texte auf 
  • Bilder werden schneller wahrgenommen und häufig besser verstanden als Text 
  • Bilder sind von der Sprache unabhängig und sparen Übersetzungskosten ein 
  • Sie stellen Informationen komprimiert dar und sparen bei gedruckten mehrsprachigen Anleitungen Platz und Kosten 
  • Bilder bieten Handlungsanweisungen, die der Anwender einfach nur nachmachen muss 

Piktogramme

Hier sehen Sie ein Beispiel für ein Piktogrammsystem, das wir speziell für einen Kunden entwickelt haben. Der Leser soll im Bruchteil einer Sekunde verstehen, worum es geht. Dabei helfen ihm gelernte schematische Symbole, die den Text visuell strukturieren. Sie dienen darüber hinaus auch hervorragend als Elemente, die den Nutzer bei der Navigation auf Internetseiten in Apps oder in Online-Anleitungen unterstützen. 

Unsere Leistungen bei Piktogrammen: 

  • Konzeption von Piktogrammsystemen 
  • Einzelpiktogramme, Piktogrammreihen 
  • Nutzertests, Styleguides 

Angebot anfragen

Hier können Sie unverbindlich ein Angebot anfordern: 

Mehr

Dokumentenanalyse Doku-Check

We rock the rules

Normen haben einen begrenzten Spaßfaktor. Sie nur zu lesen, tut manchmal körperlich weh. Allein, sie müssen sein. Denn obwohl sie so sperrig und spröde sind, ist ihr Nutzen groß, sobald sie in Ihren Technischen Produktdokumentationen umgesetzt wurden. Dann bewahren sie Sie zum Beispiel vor Haftungsklagen und optimieren Ihre Produkte durch verständliche Dokumentationen. Ihr Kunde ist dann mit Ihren Anleitungen mindestens so zufrieden wie die Gesetzgeber auf nationaler und EU-Ebene.

Wir prüfen Ihre Technischen Dokumentationen in einer umfassenden Dokumentenanalyse oder erstellen neue Dokumentationen auf der Grundlage aktueller Gesetze, Normen und Standards. Wir geben Ihnen aber auch ganz praktische Tipps, wie Sie selbst mit dem Regelwerk optimal umgehen.

Ihre Vorteile

  • Europaweite Normen-Konformität 
  • Umfassende Rechtssicherheit der Technischen Dokumentation 
  • Ausschluss von Risiken der Produkthaftung gemäß BGB § 823, § 434 
  • Aufwertung Ihres Produkts durch verständliche Anleitungen 
  • Präsentation der itl Analyse und unserer Empfehlungen 

Unsere Leistungen

  • Prüfung auf Normenkonformität 
  • Prüfung gemäß zutreffenden EU-Richtlinien 
  • Prüfung auf Einhaltung von ISO/IEC/IEEE 82079 
  • Zusätzliche Prüfung bei Softwaredokumentation gemäß Norm ISO 26514 
  • Prüfung einer elektronischen Dokumentation gemäß den Kriterien der Ergonomie-Normen 9241-11, 110 und 112 
  • Erweiterte Prüfung gemäß den Usability-Heuristiken der Nielsen Norman Group 
  • Prüfung auf Verständlichkeit 

Das sollten Sie wissen...

Unsere erfahrenen Redakteure für Technische Dokumentationen und unsere Normexperten prüfen jährlich Dutzende Technische Dokumentationen aus nahezu allen Branchen. Dazu gehören zum Beispiel Technische Dokumentationen für Produkte aus den Branchen Automatisierung, Gebäudetechnik, IT-Hard- und Software, Konsumgüter, Maschinen- und Anlagenbau sowie Messtechnik. Der Umfang reicht dabei von 10 bis zu 300 Seiten. Doch ganz unabhängig von Ihrer Branche und dem Umfang der Dokumentationen, Sie können sich am Ende darauf verlassen, dass Ihre Technischen Dokumentationen in jeder Hinsicht perfekt sind. Wir geben Ihnen aber auch ganz praktische Tipps, wie Sie selbst mit dem Regelwerk optimal umgehen.

nicht_verwenden_feature_technische_doku

Laden Sie sich den aktuellen Leitfaden zu den 16 wichtigsten Gesetzen und Normen herunter. Kostenlos für Sie.

Mehr

Ein Vorwort vom Co-Autor Dieter Gust zum itl NormenGuide

Mehr

Ihre Ansprechpartner zum Thema Smart Content

Henning Mallok

Leitung Vertrieb Deutschland

Andrea Wagner

Leitung Technische Dokumentation