Sie befinden sich hier: doctima, Service, Aktuelle Meldungen, Meldungen Archiv, API-Dokumentation.
Zur Navigation springen.
Startseite,
Kontakt,
Impressum.
Sie befinden sich hier: doctima, Service, Aktuelle Meldungen, Meldungen Archiv, API-Dokumentation.
Zur Navigation springen.
Startseite,
Kontakt,
Impressum.
API-Dokumentation für Software lässt sich aus sog. „Documentation Comments“ im Quellcode automatisch erzeugen. Da die Kommentare in der Regel von Entwicklern geschrieben werden, sind an der Entstehung einer typischen API-Dokumentation weder Redakteure noch die in einer Redaktion üblichen Werkzeuge und Prozesse beteiligt.
Dennoch übernimmt sie für bestimmte Kategorien von Software die Rolle der Referenz in der Anwenderdokumentation. Insbesondere für Programmbibliotheken oder Middleware-Systeme ist die Gebrauchstauglichkeit der API-Dokumentation entscheidend für die Verwendbarkeit des Produkts insgesamt.
In der Realität sind nur wenige Werkzeuge und Methoden im Einsatz, um die Textqualität der API-Dokumentation sicherzustellen.
doctima berät und unterstützt Sie dabei, wie Sie dennoch zu brauchbaren Ergebnissen gelangen. Sprechen Sie uns an!
Kontakt: Edgar Hellfritsch
Mit Kunden kommunizieren mehr...
Auf der Frühjahrstagung der tekom in Münster war doctima auch in diesem Jahr wieder vertreten.
mehr...
im "web & mobile DEVELOPER " mehr
vom 06. bis 07. März 2013 in Herzogenaurach mehr...
Lesen Sie das Neueste aus unserem Arbeitsalltag. mehr...
Hintergrund-Material zu den Grundlagen der Textverständ-
lichkeit von Dr. Markus Nickl.
Kontakt
Impressum
Seitenanfang
Technische Dokumentation | Institutionelle Kommunikation | Software-Lösungen | Formularoptimierung | Print- und Online-Dokumentation | Beratung | Schulung
©
doctima GmbH,
Melli-Beese-Str. 19,
90768
Fürth
Deutschland
Fügen Sie diese Seite Ihren Social Bookmarks hinzu: