Sciweavers

Share
FASE
2011
Springer

An Empirical Study on Evolution of API Documentation

8 years 1 months ago
An Empirical Study on Evolution of API Documentation
With the evolution of an API library, its documentation also evolves. The evolution of API documentation is common knowledge for programmers and library developers, but not in a quantitative form. Without such quantitative knowledge, programmers may neglect important revisions of API documentation, and library developers may not effectively improve API documentation based on its revision histories. There is a strong need to conduct a quantitative study on API documentation evolution. However, as API documentation is large in size and revisions can be complicated, it is quite challenging to conduct such a study. In this paper, we present an analysis methodology to analyze the evolution of API documentation. Based on the methodology, we conduct a quantitative study on API documentation evolution of five widely used real-world libraries. The results reveal various valuable findings, and these findings allow programmers and library developers to better understand API documentation evolu...
Lin Shi, Hao Zhong, Tao Xie, Mingshu Li
Added 28 Aug 2011
Updated 28 Aug 2011
Type Journal
Year 2011
Where FASE
Authors Lin Shi, Hao Zhong, Tao Xie, Mingshu Li
Comments (0)
books