Wissensartikel

In diesem Beitrag möchten wir Ihnen aufzeigen, wie man CDPs mit technischer Dokumentation so intelligent befüllt, dass die Nutzer schnell und gezielt Antworten auf ihre Fragestellungen bekommen. weiterlesen

Auf der Herbsttagung 2017 stellte die Arbeitsgruppe „Information 4.0“ die Version 0.9 von iiRDS vor (intelligent information Request and Delivery Standard), dem Auslieferungsstandard für Technische Dokumentation im Zeitalter von Industrie 4.0. weiterlesen

Die konsistente Verwendung von Terminologie im Unternehmen hat Vorteile: Sie vereinfacht die Kommunikation zwischen den Abteilungen und mit den Kunden, beugt Missverständnissen vor und stärkt die Produktmarke. Eine konsistente Verwendung von Terminologie bildet auch die Grundlage für kontrolliertes Schreiben. Handbücher werden verständlicher und kundenfreundlicher, Übersetzungskosten sinken und technische Redakteure gewinnen Zeit für andere Aufgaben. weiterlesen

Technische Redakteure vermitteln komplexe technische Informationen so, dass sie für die Nutzer eines Produkts oder einer Dienstleistung verständlich und zugänglich werden. Sie sind die Vermittler zwischen den Produktentwicklern und den Anwendern. Wir sind also auch Übersetzer. Nur übersetzen wir nicht von einer Sprache in die andere, sondern von der Fachsprache in eine allgemein verständliche Sprache. Und das ist häufig schwerer, als es sich anhört. weiterlesen

Befragt man Entwickler nach API-Dokumentation, tun sich ziemlich schnell zwei unterschiedliche Lager auf. Es gibt Entwickler, die davon überzeugt sind, dass guter Code überhaupt keiner Erklärung bedarf, und natürlich auf der anderen Seite auch jene Entwickler, die häufig Dokumentation lesen und sie auch selbst gern schreiben. Ebenfalls verschiedenste Meinungen und Ansätze existieren bezüglich Aussehen, Darreichung und Inhalt einer perfekten API-Dokumentation. weiterlesen