Skip to main content
Springer Nature Link
Log in

Why API documentation is insufficient for developers: an empirical study

  • Letter
  • Published:
Science China Information Sciences Aims and scope Submit manuscript

This is a preview of subscription content, log in via an institution to check access.

Access this article

Log in via an institution

Subscribe and save

Springer+ Basic
$34.99 /Month
  • Get 10 units per month
  • Download Article/Chapter or eBook
  • 1 Unit = 1 Article or 1 Chapter
  • Cancel anytime
Subscribe now

Buy Now

Price excludes VAT (USA)
Tax calculation will be finalised during checkout.

Instant access to the full article PDF.

Institutional subscriptions

References

  1. Gentleman R C, Carey V J, Bates D M, et al. Bioconductor: open software development for computational biology and bioinformatics. Genome Biol, 2004, 5: R80

    Article  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 Engineering. 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. Washington: 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. 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 

  7. 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 

Download references

Acknowledgements

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

Author information

Authors and Affiliations

  1. Key Laboratory of Parallel and Distributed Computing, College of Computer, National University of Defense Technology, Changsha, 410073, China

    Qiang Fan, Yue Yu, Tao Wang, Gang Yin & Huaimin Wang

Authors
  1. Qiang Fan
    View author publications

    You can also search for this author inPubMed Google Scholar

  2. Yue Yu
    View author publications

    You can also search for this author inPubMed Google Scholar

  3. Tao Wang
    View author publications

    You can also search for this author inPubMed Google Scholar

  4. Gang Yin
    View author publications

    You can also search for this author inPubMed Google Scholar

  5. Huaimin Wang
    View author publications

    You can also search for this author inPubMed Google Scholar

Corresponding authors

Correspondence to Qiang Fan or Yue Yu.

Rights and permissions

Reprints and permissions

About this article

Check for updates. Verify currency and authenticity via CrossMark

Cite this article

Fan, Q., Yu, Y., Wang, T. et al. Why API documentation is insufficient for developers: an empirical study. Sci. China Inf. Sci. 64, 119102 (2021). https://doi.org/10.1007/s11432-019-9880-8

Download citation

  • Received:

  • Revised:

  • Accepted:

  • Published:

  • DOI: https://doi.org/10.1007/s11432-019-9880-8