Enriching API Documentation by Relevant API Methods Recommendation Based on Version History

2018 ◽  
Author(s):  
Yuu Arimatsu ◽  
Yoshiya Ishida ◽  
Kunihiro Noda ◽  
Takashi Kobayashi
Keyword(s):  
Api Documentation

How developers use API documentation

2019 ◽  
Vol 7 (2) ◽  
pp. 40-49 ◽  
Author(s):  
Michael Meng ◽  
Stephanie Steinhardt ◽  
Andreas Schubert
Keyword(s):  
Api Documentation

An Automated Approach for Constructing Framework Instantiation Documentation

2020 ◽  
Vol 30 (04) ◽  
pp. 575-601
Author(s):  
Raquel Fialho de Queiroz Lafetá ◽  
Thiago Fialho de Queiroz Lafetá ◽  
Marcelo de Almeida Maia
Keyword(s):  
Empirical Study ◽  
Human Subjects ◽  
Source Code ◽  
High Quality ◽  
Source Code Analysis ◽  
Code Analysis ◽  
Empirical Assessment ◽  
Significant Difference ◽  
Api Documentation ◽  
Substantial Effort

A substantial effort, in general, is required for understanding APIs of application frameworks. High-quality API documentation may alleviate the effort, but the production of such documentation still poses a major challenge for modern frameworks. To facilitate the production of framework instantiation documentation, we hypothesize that the framework code itself and the code of existing instantiations provide useful information. However, given the size and complexity of existent code, automated approaches are required to assist the documentation production. Our goal is to assess an automated approach for constructing relevant documentation for framework instantiation based on source code analysis of the framework itself and of existing instantiations. The criterion for defining whether documentation is relevant would be to compare the documentation with an traditional framework documentation, considering the time spent and correctness during instantiation activities, information usefulness, complexity of the activity, navigation, satisfaction, information localization and clarity. We propose an automated approach for constructing relevant documentation for framework instantiation based on source code analysis of the framework itself and of existing instantiations. The proposed approach generates documentation in a cookbook style, where the recipes are programming activities using the necessary API elements driven by the framework features. We performed an empirical study, consisting of three experiments with 44 human subjects executing real framework instantiations aimed at comparing the use of the proposed cookbooks to traditional manual framework documentation (baseline). Our empirical assessment shows that the generated cookbooks performed better or, at least, with non-significant difference when compared to the traditional documentation, evidencing the effectiveness of the approach.

Facing up to the inequality of crowdsourced API documentation

2012 ◽  
Vol 37 (1) ◽  
pp. 1-9 ◽  
Author(s):  
Hewijin Christine Jiau ◽  
Feng-Pu Yang
Keyword(s):  
Api Documentation
Sign in / Sign up

Export Citation Format

Share Document