Abstract

Application Programming Interfaces (APIs) play a crucial role in modern software engineering. However, learning to use a new API often is a challenge for developers. In order to support the learning process effectively, we need to understand how developers use documentation when starting to work with a new API. We report an exploratory study that observed developers while they solved programming tasks involving a simple API. The results reveal differences regarding developer activities and documentation usage that a successful design strategy for API documentation needs to accommodate. Several guidelines to optimize API documentation are discussed.

Journal
Communication Design Quarterly
Published
2019-08-26
DOI
10.1145/3358931.3358937
CompPile
Search in CompPile ↗
Topics

Citation Context

Cited by in this index (0)

No articles in this index cite this work.

Cites in this index (1)

  1. Journal of Technical Writing and Communication
Also cites 18 works outside this index ↓
  1. 10.5555/3093119.3093127
  2. 10.1109/VLHCC.2011.6070395
  3. 10.1007/s10664-005-1290-x
  4. 10.1109/MS.2003.1241364
  5. 10.1016/j.infsof.2007.02.013
  6. 10.1145/2622669
  7. 10.1037/0022-0663.93.2.377
  8. 10.1109/52.676963
  9. 10.1145/2896587
  10. 10.1145/584955.584976
  11. 10.1109/MS.2009.193
  12. 10.1007/s10664-010-9150-8
  13. 10.1109/32.881720
  14. 10.5555/2819009.2819234
  15. 10.1109/ICSE.2007.92
  16. 10.1109/VLHCC.2009.5295283
  17. 10.1109/MS.2014.80
  18. 10.1145/2507065.2507076
CrossRef global citation count: 28 View in citation network →