Sie befinden sich hier: doctima, Service, Aktuelle Meldungen, API-Dokumentation.
Zur Navigation springen.
Startseite,
Kontakt,
Impressum.
Sie befinden sich hier: doctima, Service, Aktuelle Meldungen, 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
In der Umfrage finden Sie Verbesserungsvorschläge zu einem schlecht formulierten Satz aus dem Internet. mehr...
Ab sofort suchen wir
Software-Tester (m/w) mehr...
Java-Entwickler (m/w) mehr...
Technical Writer (m/f) mehr...
Technischen Redakteur (m/w) mehr...
Wie sieht eigentlich der optimale Brief aus? Dies ist Thema des aktuellen Sprachtipps von Dr. Markus Nickl in der tekom-Fachzeitschrift. mehr...
Auf der Jahrestagung der tekom in Wiesbaden war doctima auch in diesem Herbst wieder mit Fachvorträgen vertreten. mehr...
Doctima unterstützt Textqualität von API-Dokumentation mehr...
heißt eines der neuen Seminare in unserem Herbstprogramm. Nutzen Sie die Chance, Ihre Fertigkeiten in Sachen Informationsbeschaffung zu erweitern. mehr...
ist ein Angebot speziell für den Maschinenbau. Wir zeigen Ihnen, wie Sie Ihre Lastenhefte schneller erstellen und gezielter einsetzen. mehr...
Dr. Markus Nickl veröffentlicht einen Beitrag zum Thema "Die Zukunft der Anleitungstexte"
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,
Gerberei 19,
91054
Erlangen
Deutschland
Fügen Sie diese Seite Ihren Social Bookmarks hinzu: