top of page

Magazin

Für eine grenzenlose Dokumentation: Die Bedeutung von APIs nimmt zu

Die Technische Kommunikation ist nichts für Einzelkämpfer. Der Technische Redakteur, der allein in seinem stillen Kämmerlein vor sich hin arbeitet, um schließlich mit einer fertigen Dokumentation aufzuwarten, existiert nicht. Im Gegenteil: Die Arbeit im Team stellt einen Großteil des Berufsalltags in der Technischen Redaktion dar. Dass die Zusammenarbeit für Technische Redakteure von hoher Bedeutung ist, bestätigt auch eine Umfrage, die der Softwarehersteller k15t auf der tekom-Jahrestagung durchgeführt hat. Über 44 Prozent der Befragten halten die Zusammenarbeit in der Technischen Redaktion demnach für „sehr wichtig“, rund 28 Prozent stufen sie als „wichtig“ ein.

Das gemeinsame Erarbeiten einer Technischen Dokumentation bietet viele Vorteile, weist aber auch Fallstricke auf. In der gleichen Befragung wurde deutlich, dass die Wahl des präferierten Redaktionssystems eine sehr individuelle Entscheidung ist. Es sind also zahlreiche unterschiedliche Systeme im Einsatz. Daraus ergibt sich das Problem, dass die Eingliederung von Fremddokumentationen im Rahmen der Kooperation zur Herausforderung wird.


Einen Ausweg bieten APIs (Application Programming Interface). Solche Programmierschnittstellen vereinfachen die Zusammenarbeit, indem sie den medienbruchfreien Austausch von Dokumenten ermöglichen. Ihre Bedeutung ist in den letzten Jahren gewachsen und in Zukunft werden sie eine noch größere Rolle spielen. Dies bestätigen auch die Marktforscher von Forrester, die die wachsende Relevanz von APIs zu den zehn wichtigsten IT-Trends in 2018 zählen.

 

Bedingt durch die Globalisierung ist auch die Kooperation über Ländergrenzen hinweg heute Normalität. Neben der Verwendung von unterschiedlichen Redaktionssystemen stellt hier natürlich die Sprache das größte Hindernis dar. Auch an dieser Stelle sind APIs alternativlos. Ein Beispiel ist COTI (Common Translation Interface). Dieser vom DERCOM entwickelte Standard hilft bei der Übersetzung von Technischen Dokumentationen und ermöglicht den automatisierten Datenaustausch via Schnittstelle. Obwohl es sich um eine Standard-API handelt, kann der Anwender je nach Bedürfnis ein Übersetzungsprogramm seiner Wahl nutzen, ohne Inkompatibilität fürchten zu müssen. Damit gelingt der Brückenschlag zwischen Standardisierung auf der einen und Flexibilität auf der anderen Seite. Solche Standards werden im besten Fall von der gesamten Branche eingehalten und helfen dabei, die wachsenden Herausforderungen in der Technischen Dokumentation kostensparend und doch mitarbeiterfreundlich zu meistern.  

bottom of page