Facing up to the inequality of crowdsourced API documentation

Author:

Jiau Hewijin Christine1,Yang Feng-Pu1

Affiliation:

1. National Cheng Kung University, Tainan, Taiwan

Abstract

API usability is a crucial issue in software development. One bottleneck of API usability is insufficient documentation. This study empirically confirmed the inequality of crowdsourced API documentation, which is one of the main sources of API documentation. To manage the inequality, a method for documentation reuse is proposed based on the nature of object-oriented programming language, inheritance. A case study was conducted in Stackoverflow, which is a widely used Q&A site, to study the feasibility of the documentation reuse. Results of the case study indicate that documentation reuse is feasible in improving both the coverage and quality of crowdsourced API documentations.

Publisher

Association for Computing Machinery (ACM)

Reference12 articles.

1. Example-centric programming

2. Writing Code to Prototype, Ideate, and Discover

3. Timothy Budd. "An Introduction to Object - oriented Programming" pages 162--163. Addison Wesley 3rd edition 2001. Timothy Budd. "An Introduction to Object - oriented Programming" pages 162--163. Addison Wesley 3rd edition 2001.

4. API usability

Cited by 11 articles. 订阅此论文施引文献 订阅此论文施引文献,注册后可以免费订阅5篇论文的施引文献,订阅后可以查看论文全部施引文献

1. GUI-Based YOLOv8 License Plate Detection System Design;2023 5th International Conference on Control and Robotics (ICCR);2023-11-23

2. A user survey on the adoption of crowd-based software engineering instructional screencasts by the new generation of software developers;Journal of Systems and Software;2022-03

3. Automatic API Usage Scenario Documentation from Technical Q&A Sites;ACM Transactions on Software Engineering and Methodology;2021-05

4. A feature location approach for mapping application features extracted from crowd-based screencasts to source code;Empirical Software Engineering;2020-09-16

5. Mining API usage scenarios from stack overflow;Information and Software Technology;2020-06

同舟云学术

1.学者识别学者识别

2.学术分析学术分析

3.人才评估人才评估

"同舟云学术"是以全球学者为主线,采集、加工和组织学术论文而形成的新型学术文献查询和分析系统,可以对全球学者进行文献检索和人才价值评估。用户可以通过关注某些学科领域的顶尖人物而持续追踪该领域的学科进展和研究前沿。经过近期的数据扩容,当前同舟云学术共收录了国内外主流学术期刊6万余种,收集的期刊论文及会议论文总量共计约1.5亿篇,并以每天添加12000余篇中外论文的速度递增。我们也可以为用户提供个性化、定制化的学者数据。欢迎来电咨询!咨询电话:010-8811{复制后删除}0370

www.globalauthorid.com

TOP

Copyright © 2019-2024 北京同舟云网络信息技术有限公司
京公网安备11010802033243号  京ICP备18003416号-3