Wissensartikel

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

Das Stichwort agil ist in der Softwareentwicklung mindestens so beliebt wie DITA in der Technischen Dokumentation. Kein Wunder: Agil und DITA konzentrieren sich auf Modularisierung und die Anforderungen der Nutzer. Dieser Artikel beleuchtet, wie agiles Dokumentieren in der Praxis funktioniert, welche Tools die Prozesse unterstützen und welche Vor- und Nachteile sich für ein Dokumentationsteam ergeben. weiterlesen