Measuring API documentation on the web
The DOI matches its Crossref record.
Abstract
Software development blogs, developer forums and Q&A websites are changing the way software is documented. With these tools, developers can create and communicate knowledge and experiences without relying on a central authority to provide official documentation. Instead, any content created by a developer is just a web search away. To understand whether documentation via social media can replace or augment more traditional forms of documentation, we study the extent to which the methods of one particular API - jQuery - are documented on the Web. We analyze 1,730 search results and show that software development blogs in particular cover 87.9% of the API methods, mainly featuring tutorials and personal experiences about using the methods. Further, this effort is shared by a large group of developers contributing just a few blog posts. Our findings indicate that social media is more than a niche in software documentation, that it can provide high levels of coverage and that it gives readers a chance to engage with authors.
Overview
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
The claims and statistics of this paper haven’t been checked yet.
Free: it reads the open-access text and checks the first 5 claims that cite a source we can check. Create a free account to check every claim.
Self-check
Percentages, sums and reported differences re-computed from the paper’s own numbers.
The self-check needs the paper’s full text.
Citations
Cited by
What makes a good code example?: A study of programming Q&A in StackOverflow
Nasehi, S. M., Sillito, J., Maurer, F., & Burns, C. (2012) · 2012 28th IEEE International Conference on Software Maintenance (ICSM) · doi:10.1109/icsm.2012.6405249 · Cited by 287
A Theory of Robust API Knowledge
Thayer, K., Chasins, S. E., & Ko, A. J. (2021) · ACM Transactions on Computing Education · doi:10.1145/3444945 · Cited by 25
A Survey on Online Learning Preferences for Computer Science and Programming
Escobar-Avila, J., Venuti, D., Di Penta, M., & Haiduc, S. (2019) · 2019 IEEE/ACM 41st International Conference on Software Engineering: Software Engineering Education and Training (ICSE-SEET) · doi:10.1109/icse-seet.2019.00026 · Cited by 24
Web usage patterns of developers
Corley, C. S., Lois, F., & Quezada, S. (2015) · 2015 IEEE International Conference on Software Maintenance and Evolution (ICSME) · doi:10.1109/icsm.2015.7332489 · Cited by 10
Metadata
- Authors
- Parnin, C., & Treude, C.
- Venue
- Proceedings of the 2nd International Workshop on Web 2.0 for Software Engineering
- Publisher
- ACM
- Published
- 2011-05-24
- Pages
- 25-30
- OpenAlex
- W2066998448
- Cited by
- 121
- References
- 0
- FWCI
- 8.17
- Type
- conference paper
- Language
- en
- Open access
- closed
About these checks
Registry, retraction, Cites and statistics results are computed, not judged, with one exception: a printed reference that no index lists is read once by a model before it counts as a citation error. Claims are extracted by a model and kept only when their quote appears verbatim in the text; each cited source is then checked, with a model’s help, for whether it says what the claim relies on. Those verdicts can be wrong — read the claim’s quote and the cited source before relying on one.
Statistics and arithmetic are recomputed, not judged.
Confidence bands are shown only for fields calibrated on our annotated test set. None is calibrated yet, so no band is shown.
What counts as a claim ›How we measure confidence ›How we check this ›
Are you an author, or do you see a problem with this page? Request a review
How to cite
Cite CoChat for the checks on this page, and the paper for its own findings.
- This page
- CoChat. (2026). Citation check: Measuring API documentation on the web. https://app.cochat.ai/papers/10.1145/1984701.1984706
- The paper
- Parnin, C., & Treude, C. (2011). Measuring API documentation on the web. Proceedings of the 2nd International Workshop on Web 2.0 for Software Engineering. https://doi.org/10.1145/1984701.1984706
Data sources
Bibliographic data: Semantic Scholar, OpenAlex, Crossref.
Contains information from the Semantic Scholar Academic Graph Datasets, made available under the ODC Attribution License (ODC-BY 1.0).
Semantic Scholar’s data is described in: Kinney, R., et al. (2023). The Semantic Scholar Open Data Platform. arXiv:2301.10140.