Student or educator? Sign up with your school email and get 6 months of Pro free.
CoChat

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?

Meng, Michael, Steinhardt, Stephanie, Schubert, Andreas · 2018 · Journal of Technical Writing and Communication

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

Crossref · 10.1177/0047281617721853

Cites

37 of 37 references verified0 citation errors · 0 not checkable

Statistics

Recomputing p-values needs the paper’s full text.

Verification

Claims the paper makes

This paper’s full text isn’t openly available, so its claims and self-check weren’t run. The registry and citation checks still apply.

Citations

Cites

Show all 37 references

Research works printed but not linked: 6

  1. Clarke S., 2004, Dr. Dobb’s Journal, 29, S6
  2. 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/.
  3. Mayring P., 2015, Qualitative Inhaltsanalyse: Grundlagen und Techniken [Qualitative content analysis: Foundations and procedures]
  4. 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/.
  5. 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/.
  6. Zibran M., 2008, International Journal of Computer Science and Network Security, 8, 255

Cited by

See all 78

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
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.