Abstract
The documentation of popular APIs is spread across many formats, from vendor-curated reference documentation to Stack Overflow threads. For developers, it is often not obvious from where a particular piece of information can be retrieved. To understand this documentation landscape, we systematically conducted Google searches for the elements of ten popular APIs. We found that their documentation is widely dispersed among many sources, that GitHub and Stack Overflow play a prominent role among the search results, and that most sources are quick to document new API functionalities. These findings inform API vendors about where developers find documentation about their products, they inform developers about places to look for documentation, and they enable researchers to further study the software documentation landscape.
| Original language | English |
|---|---|
| Title of host publication | WAPI '18 |
| Subtitle of host publication | Proceedings of the 2nd International Workshop on API Usage and Evolution |
| Place of Publication | New York |
| Publisher | Association for Computing Machinery (ACM) |
| Pages | 19-22 |
| Number of pages | 4 |
| ISBN (Print) | 978-1-4503-5754-8 |
| DOIs | |
| Publication status | Published - 2018 |
| Event | WAPI 2018: 2nd International Workshop on API Usage and Evolution - Gothenburg, Sweden Duration: 2 Jun 2018 → 2 Jun 2018 Conference number: 2 https://w-api.github.io/ |
Workshop
| Workshop | WAPI 2018 |
|---|---|
| Abbreviated title | WAPI'18 |
| Country/Territory | Sweden |
| City | Gothenburg |
| Period | 2/06/18 → 2/06/18 |
| Internet address |