Key points are not available for this paper at this time.
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.
Building similarity graph...
Analyzing shared references across papers
Loading...
Uddin et al. (Wed,) studied this question.
synapsesocial.com/papers/6a0eccdd06ecbe833447d0af — DOI: https://doi.org/10.1109/ms.2014.80
Gias Uddin
University of Calgary
Martin P. Robillard
McGill University
IEEE Software
McGill University
Building similarity graph...
Analyzing shared references across papers
Loading...