In einer vernetzten Welt gewinnen Programmschnittstellen, APIs, an Bedeutung. Da APIs nicht selbsterklärend sind, braucht es eine gute Dokumentation. Doch wie sollte sie aussehen, damit Entwickler optimal unterstützt werden? Die Forschung der Hochschule Merseburg liefert Antworten.
Im Bereich der Softwareentwicklung sind ganz verschiedene Arten von Dokumentationen anzutreffen. Für die Endnutzer von Software gibt es zum Beispiel die Anwenderdokumentation, meist geschrieben von Technischen Redakteuren. Sie klärt vorrangig die Nutzung der Software. Demgegenüber steht die Entwicklerdokumentation, meist stammt sie von Entwicklern, die die technische Seite hinter der Benutzeroberfläche dokumentieren. Die Anwenderdokumentation verlässt das Unternehmen und ist für eine externe Verwendung bestimmt. Die Entwicklerdokumentation wird hingegen intern genutzt.
Die Dokumentation von APIs (Inf. 01) reiht sich zwischen diese beiden Arten der Softwaredokumentation ein. Die API-Dokumentation ist eine überwiegend technische Beschreibung von Architektur und Code und verlässt das Haus, da sie für externe Entwickler bestimmt ist.
Definition von APIAPI ist das Kurzwort ... |
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.
