The DOI matches its Crossref record; 37 of the 37 references it cites were found in a registry or an index.
Application Programming Interface Documentation: What Do Software Developers Want?
Abstract
The success of an application programming interface (API) crucially depends on how well its documentation meets the information needs of software developers. Previous research suggests that these information needs have not been sufficiently understood. This article presents the results of a series of semistructured interviews and a follow-up questionnaire conducted to explore the learning goals and learning strategies of software developers, the information resources they turn to and the quality criteria they apply to API documentation. Our results show that developers initially try to form a global understanding regarding the overall purpose and main features of an API, but then adopt either a concepts-oriented or a code-oriented learning strategy that API documentation both needs to address. Our results also show that general quality criteria such as completeness and clarity are relevant to API documentation as well. Developing and maintaining API documentation therefore need to involve the expertise of communication professionals.
Overview
Integrity signals
Registry
Cites
Statistics
Verification
Claims the paper makes
Citations
Cites
R: A Language and Environment for Statistical Computing
R Core Team (2025) · doi:10.32614/r.manuals · Cited by 352,181
Qualitative Content Analysis: Theoretical Background and Procedures
Mayring, P. (2015) · Advances in Mathematics Education · doi:10.1007/978-94-017-9181-6_13 · Cited by 2,263
Self-Directed Learning, A Guide for Learners and Teachers
McNally, J. M. (1976) · The Journal of Continuing Education in Nursing · doi:10.3928/0022-0124-19760501-17 · Cited by 2,234
Qualitative Text Analysis: A Guide to Methods, Practice & Using Software
Kuckartz, U. (2014) · doi:10.4135/9781446288719 · Cited by 1,411
(2009) · doi:10.1057/9780230244276 · Cited by 672
Information Needs in Collocated Software Development Teams
Ko, A. J., DeLine, R., & Venolia, G. (2007) · 29th International Conference on Software Engineering (ICSE'07) · doi:10.1109/icse.2007.45 · Cited by 499
Studying Software Engineers: Data Collection Techniques for Software Field Studies
Lethbridge, T. C., Sim, S. E., & Singer, J. (2005) · Empirical Software Engineering · doi:10.1007/s10664-005-1290-x · Cited by 494
How do programmers ask and answer questions on the web? (NIER track)
Treude, C., Barzilay, O., & Storey, M.-A. (2011) · Proceedings of the 33rd International Conference on Software Engineering · doi:10.1145/1985793.1985907 · Cited by 405
Schriver, K. A. (1998) · College Composition and Communication · doi:10.2307/358576 · Cited by 384
What Makes APIs Hard to Learn? Answers from Developers
Robillard, M. P. (2009) · IEEE Software · doi:10.1109/ms.2009.193 · Cited by 382
Research works printed but not linked: 6
- Clarke S., 2004, Dr. Dobb’s Journal, 29, S6
- Clarke, S. (2007). What is an end user software engineer? In Dagstuhl Seminar Proceedings . Schloss Dagstuhl-Leibniz-Zentrum für Informatik. Retrieved from http://drops.dagstuhl.de/opus/volltexte/2007/1080/.
- Mayring P., 2015, Qualitative Inhaltsanalyse: Grundlagen und Techniken [Qualitative content analysis: Foundations and procedures]
- Stylos, J. (2009). Making APIs more usable with improved API design, documentation and tools (Doctoral dissertation). Carnegie Mellon University. Retrieved from http://www.cs.cmu.edu/∼NatProg/papers/.
- Watson, R. B. (2015). The effect of visual design and information content on readers’ assessments of API reference topics (Doctoral dissertation). University of Washington. Retrieved from https://digital.lib.washington.edu/researchworks/.
- Zibran M., 2008, International Journal of Computer Science and Network Security, 8, 255
Cited by
Using an LLM to Help With Code Understanding
Nam, D., Macvean, A., Hellendoorn, V., Vasilescu, B., & Myers, B. (2024) · Proceedings of the IEEE/ACM 46th International Conference on Software Engineering · doi:10.1145/3597503.3639187 · Cited by 487
“During the pilot studies, we observed that participants approached the tasks differently depending on their familiarity with other LLM-based tools, and styles of information processing and learning as observed in many previous studies on software documentation and debugging [4, 46, 47].”
BackgroundMethodExperiences with Improving the Transparency of AI Models and Services
Hind, M., Houde, S., Martino, J., Mojsilovic, A., Piorkowski, D., Richards, J., & Varshney, K. R. (2020) · Extended Abstracts of the 2020 CHI Conference on Human Factors in Computing Systems · doi:10.1145/3334480.3383051 · Cited by 44
Turnover-induced knowledge loss in practice
Robillard, M. P. (2021) · Proceedings of the 29th ACM Joint Meeting on European Software Engineering Conference and Symposium on the Foundations of Software Engineering · doi:10.1145/3468264.3473923 · Cited by 29
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
Metadata
- Authors
- Meng, M., Steinhardt, S., & Schubert, A.
- Affiliations
- Merseburg University of Applied Sciences (DE)
- Corresponding author
- Meng, Michael
- Venue
- Journal of Technical Writing and Communication
- Publisher
- SAGE Publications
- Published
- 2017-07-26
- Volume
- 48
- Issue
- 3
- Pages
- 295-330
- ISSN
- 0047-2816 (ISSN-L)
- 1541-3780
- OpenAlex
- W2739693438
- Cited by
- 78
- References
- 37
- Citations by year
- 2026: 4 · 2025: 3 · 2024: 17 · 2023: 13 · 2022: 13 · 2021: 14 · 2020: 8 · 2019: 3 · 2018: 3
- FWCI
- 7.13
- Type
- journal article
- Language
- en
- Open access
- closed
- Licence
- journals.sagepub.com/page/policies/text-and-data-mining-license (tdm)
- Locations
- Journal of Technical Writing and Communication (publishedVersion)
- Topics
- Physical Sciences › Computer Science › Information Systems › Software Engineering Research
- Physical Sciences › Computer Science › Information Systems › Software Engineering Techniques and Practices
- Physical Sciences › Computer Science › Human-Computer Interaction › Usability and User Interface Design
- Keywords
- application programming interfaces, API documentation, software developers, information needs, learning strategies, documentation completeness, technical communication
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: Application Programming Interface Documentation: What Do Software Developers Want? https://app.cochat.ai/papers/10.1177/0047281617721853
- The paper
- Meng, M., Steinhardt, S., & Schubert, A. (2018). Application Programming Interface Documentation: What Do Software Developers Want? Journal of Technical Writing and Communication. https://doi.org/10.1177/0047281617721853
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.