Where does Google find API documentation?

نویسندگان

  • Christoph Treude
  • Maurício Aniche
چکیده

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. ACM Reference Format: Christoph Treude and Maurício Aniche. 2018. Where does Google find API documentation?. In WAPI’18: WAPI’18: IEEE/ACM 2nd International Workshop on API Usage and Evolution, June 2–4, 2018, Gothenburg, Sweden. ACM, New York, NY, USA, 4 pages. https://doi.org/10.1145/3194793.3194796

برای دانلود رایگان متن کامل این مقاله و بیش از 32 میلیون مقاله دیگر ابتدا ثبت نام کنید

ثبت نام

اگر عضو سایت هستید لطفا وارد حساب کاربری خود شوید

منابع مشابه

Crowd Documentation: Exploring the Coverage and the Dynamics of API Discussions on Stack Overflow

Traditionally, many types of software documentation, such as API documentation, require a process where a few people write for many potential users. The resulting documentation, when it exists, is often of poor quality and lacks sufficient examples and explanations. In this paper, we report on an empirical study to investigate how Question and Answer (Q&A) websites, such as Stack Overflow, faci...

متن کامل

Broken Fingers: On the Usage of the Fingerprint API in Android

Smartphones are increasingly used for very important tasks such as mobile payments. Correspondingly, new technologies are emerging to provide better security on smartphones. One of the most recent and most interesting is the ability to recognize fingerprints, which enables mobile apps to use biometric-based authentication and authorization to protect security-sensitive operations. In this paper...

متن کامل

Historical Gazetteer System Integration: CHGIS, Regnum Francorum, and GeoNames

Integration of digital gazetteers, involving the disambiguation of unique places and conflation of duplicates or variant placeneames, has been the focus of many theoretical papers in recent years. The challenge of mapping between historical instances of placenames is also an ongoing concern for several important projects dealing with ancient placenames. Here the matching of historical placename...

متن کامل

Integration of a city GIS data with Google Map API and Google Earth API for a web based 3D Geospatial Application

Geospatial applications are becoming indispensible part of information systems, they provides detailed information’s regarding the attribute data of spatial objects in real world. Due to the rapid technological developments in web based geographical information systems, the uses of web based geospatial application varies from Geotagging to Geolocation capabilities. Therefore, effective utilizat...

متن کامل

Classifying and Recommending Knowledge in Reference Documentation to Improve Api Usability

Reference documentation is an important source of information on API usage. Programmers, however, can easily overlook reference information because of its tedious nature, and because the information they seek can be buried among irrelevant or boiler-plate text. We propose to detect and recommend fragments of API documentation relevant and important to a task. We categorize pieces of information...

متن کامل

ذخیره در منابع من


  با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید

عنوان ژورنال:

دوره   شماره 

صفحات  -

تاریخ انتشار 2018