Das Beste aus zwei Welten

Text: Marc Achtelig

Eine Technische Redaktion hat oft die Aufgabe, die Bedienung einer Software und gleichzeitig ihre Schnittstellen zu dokumentieren. Keine leichte Aufgabe, da sie mehrere Werkzeuge dafür benötigt. Bislang zumindest, denn das Redaktionssystem Document!X verspricht Unterstützung.

Mit der zunehmenden Anzahl an Softwareprodukten mit nach außen offenen Schnittstellen steigt der Bedarf, die Schnittstellen zusammen mit dem Produkt zu dokumentieren. Für diese Aufgabe gibt es immer noch vergleichsweise wenig kombinierte Tool-Unterstützung. Eine der wenigen kommerziellen Lösungen ist Document!X. Die Software generiert automatisch aus der Struktur des Quellcodes sowie aus im Quellcode hinterlegten Kommentaren eine (Schnittstellen-)Dokumentation, die im Redaktionssystem mit redaktionell gepflegten Inhalten nahtlos verknüpft werden kann.

Darum geht es

In der redaktionellen Praxis und bei den Autorenwerkzeugen sind die eher technisch orientierte Softwaredokumentation und die reine Benutzerdokumentation oft noch getrennte Welten:

Für die Dokumentation von Schnittstellen (API-Dokumentation) ist eine fast unüberschaubare Anzahl hoch spezialisierter Open-Source-Tools ...

Das Beste aus zwei Welten