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 ...
Weiterlesen nach Login
tekom-Mitglieder können sich direkt mit ihren "meine tekom"-Zugangsdaten anmelden.
Sie sind noch kein tekom-Mitglied, möchten aber einen oder mehrere Fachartikel vollständig lesen? Dann haben Sie die Möglichkeit, sich auf dem Internetportal der Fachzeitschrift 'technische kommunikation' völlig unverbindlich zu registrieren. Nach der Registrierung können Sie drei beliebige Fachartikel auswählen und für einen Zeitraum von zwei Monaten vollständig eingesehen. Danach wird die Auswahl gelöscht und Sie können drei neue Artikel für die nächsten zwei Monate bestimmen.
Als tekom-Mitglied profitieren Sie von folgenden Vorteilen:
- Online-Zugriff auf alle Artikel der Fachzeitschrift 'technische kommunikation'
- Exklusive Fachartikel aus allen Bereichen der Technischen Kommunikation
- Regelmäßig neue Artikel von über 400 Autoren
- Die Fachzeitschrift 'technische kommunikation' als gedruckte Ausgabe
- Vergünstigte Eintrittspreise zu tekom-Tagungen
- Mitgliedspreise für tekom-Publikationen
- Zugang zu 'meine tekom', dem Webforum mit Jobangeboten / -gesuchen, Terminen, Expertenrat, Dienstleisterdatei und vieles mehr
Anmelden
Registrieren
Versprochen: Die Fachzeitschrift 'technische kommunikation' ist das Beste, was wir haben. Und wir machen uns die Auswahl nicht leicht. Jeden Monat veröffentlicht die Redaktion der Fachzeitschrift 'technische kommunikation' die neuesten Fachartikel namhafter Autoren. Diese anspruchsvolle Auswahl gibt es exklusiv nur für Mitglieder der tekom (wie gewohnt inklusive der gedruckten Ausgabe).
Die Fachzeitschrift 'technische kommunikation' steht für intelligent aufbereitete Fachartikel, auf den Punkt geschriebene Texte, informative Inhalte, überraschende Einsichten, internationale Perspektiven und vermittelt Technische Kommunikation verständlich, schnell, klar, ohne Umstände – exklusiv für Sie.
