Wissensartikel

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

Wer eine Gebrauchsanleitung erstellt, hat mit jeder Menge Wissen zu tun. Durch die Recherche erarbeitet sich der Technische Redakteur Wissen, das er anschließend bewerten und weiterverwenden muss. Kenntnisse über Wissensmodellierung sind dabei äußerst hilfreich. Weiterlesen

This case study shows how Scriptorium Publishing created the free DITA learning website LearningDITA by combining the DITA learning and training specialization, GitHub, XSLT, video, and WordPress—and how parson AG adapted those technologies to develop the German site, LearningDITA.de. Weiterlesen

Auf der diesjährigen Herbsttagung stellte die Arbeitsgruppe „Information 4.0“ der Gesellschaft für Technische Kommunikation die ersten Arbeitsergebnisse zum neuen Auslieferungsstandard für Technische Dokumentation im Zeitalter von Industrie 4.0 vor: iiRDS. Weiterlesen