AI Chat Paper
Note: Please note that the following content is generated by AMiner AI. SciOpen does not take any responsibility related to this content.
{{lang === 'zh_CN' ? '文章概述' : 'Summary'}}
{{lang === 'en_US' ? '中' : 'Eng'}}
Chat more with AI
Article Link
Collect
Submit Manuscript
Show Outline
Outline
Show full outline
Hide outline
Outline
Show full outline
Hide outline
Regular Paper

An Empirical Comparison Between Tutorials and Crowd Documentation of Application Programming Interface

School of Software, Dalian University of Technology, Dalian 116000, China
Key Laboratory for Ubiquitous Network and Service Software of Liaoning Province, Dalian 116000, China
School of Computer Science & Technology, Beijing Institute of Technology, Beijing 100000, China
Show Author Information

Abstract

API (application programming interface) documentation is critical for developers to learn APIs. However, it is unclear whether API documentation indeed improves the API learnability for developers. In this paper, we focus on two types of API documentation, i.e., official API tutorials and API crowd documentation. First, we analyze API coverage and check API consistencies in API documentation based on the API traceability. Then, we conduct a survey and extract several characteristics to analyze which API documentation can help developers learn APIs. Our findings show that: 1) API crowd documentation can be regarded as a supplement to the official API tutorials to some extent; 2) the concerns for frequently-used APIs between different types of API documentation show a huge mismatch, which may prevent developers from deeply understanding the usages of APIs through only one type of API documentation; 3) official API tutorials can help developers seek API information on a long page and API crowd documentation could provide long codes for a particular programming task. These findings may help developers select the suitable API documentation and find the useful information they need.

Electronic Supplementary Material

Download File(s)
jcst-36-4-856-Highlights.pdf (399.7 KB)

References

【1】
【1】
 
 
Journal of Computer Science and Technology
Pages 856-876

{{item.num}}

Comments on this article

Go to comment

< Back to all reports

Review Status: {{reviewData.commendedNum}} Commended , {{reviewData.revisionRequiredNum}} Revision Required , {{reviewData.notCommendedNum}} Not Commended Under Peer Review

Review Comment

Close
Close
Cite this article:
Tang Y-X, Ren Z-L, Jiang H, et al. An Empirical Comparison Between Tutorials and Crowd Documentation of Application Programming Interface. Journal of Computer Science and Technology, 2021, 36(4): 856-876. https://doi.org/10.1007/s11390-020-0042-0

976

Views

1

Crossref

1

Web of Science

1

Scopus

0

CSCD

Received: 18 September 2019
Accepted: 17 May 2020
Published: 05 July 2021
©Institute of Computing Technology, Chinese Academy of Sciences 2021