Recommending reference API documentation

@article{Robillard2014RecommendingRA,
  title={Recommending reference API documentation},
  author={Martin P. Robillard and Yam B. Chhetri},
  journal={Empirical Software Engineering},
  year={2014},
  volume={20},
  pages={1558-1586}
}
Reference documentation is an important source of information on API usage. However, information useful to programmers can be buried in irrelevant text, or attached to a non-intuitive API element, making it difficult to discover. We propose to detect and recommend fragments of API documentation potentially important to a programmer who has already decided to use a certain API element. We categorize text fragments in API documentation based on whether they contain information that is… CONTINUE READING
Highly Cited
This paper has 35 citations. REVIEW CITATIONS

From This Paper

Figures, tables, results, and topics from this paper.

Key Quantitative Results

  • In an evaluation study with randomly-sampled method definitions from ten open source systems, we found that with a training set derived from about 1000 documentation units, we could issue recommendations with 90 % precision and 69 % recall.

Citations

Publications citing this paper.
Showing 1-10 of 21 extracted citations

A Large-Scale Empirical Study on Linguistic Antipatterns Affecting APIs

2018 IEEE International Conference on Software Maintenance and Evolution (ICSME) • 2018
View 1 Excerpt

Improving API Caveats Accessibility by Mining API Caveats Knowledge Graph

2018 IEEE International Conference on Software Maintenance and Evolution (ICSME) • 2018
View 2 Excerpts

Toward Automatic Summarization of Arbitrary Java Statements for Novice Programmers

2018 IEEE International Conference on Software Maintenance and Evolution (ICSME) • 2018
View 1 Excerpt

An Unsupervised Approach for Discovering Relevant Tutorial Fragments for APIs

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE) • 2017
View 1 Excerpt

Analyzing APIs Documentation and Code to Detect Directive Defects

2017 IEEE/ACM 39th International Conference on Software Engineering (ICSE) • 2017
View 1 Excerpt

How Developers Document Pull Requests with External References

2017 IEEE/ACM 25th International Conference on Program Comprehension (ICPC) • 2017
View 3 Excerpts

References

Publications referenced by this paper.
Showing 1-10 of 36 references

Effective Java, 2nd Edition

The Java series ... from the source • 2008
View 10 Excerpts
Highly Influenced

Improving API documentation usability with knowledge pushing

2009 IEEE 31st International Conference on Software Engineering • 2009
View 6 Excerpts
Highly Influenced

Framework Design Guidelines: Conventions, Idioms, and Patterns for Reusable .NET Libraries (Second Edition)

K Cwalina, B Abrams
2008
View 3 Excerpts
Highly Influenced

Speech and Language Processing

View 1 Excerpt
Highly Influenced

J2SE 5.0 in a nutshell. Sun Developer Network Article, http://java

C Austin
2004
View 1 Excerpt
Highly Influenced

Developer Profiles for Recommendation Systems

Recommendation Systems in Software Engineering • 2014
View 1 Excerpt

Patterns of Knowledge in API Reference Documentation

IEEE Transactions on Software Engineering • 2013
View 3 Excerpts

Asking and answering questions about unfamiliar APIs: An exploratory study

2012 34th International Conference on Software Engineering (ICSE) • 2012
View 1 Excerpt

Similar Papers

Loading similar papers…