How API Documentation Fails

Formal documentation can be a crucial resource for learning to how to use an API. However, producing high-quality documentation can be nontrivial. Researchers investigated how 10 common documentation problems manifested themselves in practice. The results are based on two surveys of a total of 323 p...

Ausführliche Beschreibung

Gespeichert in:
Bibliographische Detailangaben
Veröffentlicht in:IEEE software Jg. 32; H. 4; S. 68 - 75
Hauptverfasser: Uddin, Gias, Robillard, Martin P.
Format: Journal Article
Sprache:Englisch
Veröffentlicht: Los Alamitos IEEE 01.07.2015
IEEE Computer Society
Schlagworte:
API
Application programming interface
Application programming interfaces
Documentation
Failure analysis
Software development
software engineering
Studies
Uniform resource locators
user study
ISSN:0740-7459, 1937-4194
Online-Zugang:Volltext
Tags: Tag hinzufügen
Keine Tags, Fügen Sie den ersten Tag hinzu!
Beschreibung
Zusammenfassung:Formal documentation can be a crucial resource for learning to how to use an API. However, producing high-quality documentation can be nontrivial. Researchers investigated how 10 common documentation problems manifested themselves in practice. The results are based on two surveys of a total of 323 professional software developers and analysis of 179 API documentation units. The three severest problems were ambiguity, incompleteness, and incorrectness of content. The respondents often mentioned six of the 10 problems as "blockers"' that forced them to use another API.
Bibliographie:SourceType-Scholarly Journals-1
ObjectType-Feature-1
content type line 14
ISSN:0740-7459
1937-4194
DOI:10.1109/MS.2014.80