SCIENCE CHINA Information Sciences, Volume 64 , Issue 1 : 119102(2021) https://doi.org/10.1007/s11432-019-9880-8

Why API documentation is insufficient for developers: an empirical study

More info
  • ReceivedJan 3, 2019
  • AcceptedMar 21, 2019
  • PublishedOct 30, 2020


There is no abstract available for this article.


This work was supported by National Grand RD Plan (Grant No. 2018-YFB1004202) and National Natural Science Foundation of China (Grant No. 61702534).


[1] Gentleman R C, Carey V J, Bates D M. Bioconductor: open software development for computational biology and bioinformatics.. Genome Biol, 2004, 5: R80 CrossRef PubMed Google Scholar

[2] Forward A, Lethbridge T C. The relevance of software documentation, tools and technologies: a survey. In: Proceedings of the 2002 ACM Symposium on Document engi-neering. New York: ACM, 2002. 26--33. Google Scholar

[3] Roehm T, Tiarks R, Koschke R, et al. How do professional developers comprehend software? In: Proceedings of the 34th International Conference on Software Engineering. New York: IEEE Press, 2012. 255--265. Google Scholar

[4] Dekel U, Herbsleb J D. Improving api documentation usability with knowledge pushing. In: Proceedings of the 31st International Conference on Software Engineering. IEEE Computer Society, 2009. 320--330. Google Scholar

[5] Chen C, Zhang K. Who asked what: Integrating crowdsourced faqs into api documentation. In: Proceedings of the 36th International Conference on Software Engineering.New York: ACM, 2014. 456--459. Google Scholar

[6] Uddin G, Robillard M P. How API documentation fails. IEEE Software, 2015, 32: 68--75. Google Scholar

[7] Hartmann B, Dhillon M, Chan M K. Hypersource: bridging the gap between source and code-related web sites. In: Proceedings of the SIGCHI Conference on Human Factors in Computing Systems.New York: ACM, 2011. 2207--2210. Google Scholar

[8] Linares-Vasquez M, Bavota G, Di Penta M, et al. How do api changes trigger stack overflow discussions? a study on the android sdk. In: Proceedings of the 22nd International Conference on Program Comprehension. New York: ACM, 2014. 83--94. Google Scholar