Affiliation:
1. Merseburg University of Applied Sciences
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.
Publisher
Association for Computing Machinery (ACM)
Subject
General Arts and Humanities
Reference26 articles.
1. Johnson T. (n.d.): What is a REST API? {blog post}. Retrieved from https://idratherbewriting.com/learnapidoc/docapis_what_is_a_rest_api.html checked on 10/01/2018. Johnson T. (n.d.): What is a REST API? {blog post}. Retrieved from https://idratherbewriting.com/learnapidoc/docapis_what_is_a_rest_api.html checked on 10/01/2018.
Cited by
19 articles.
订阅此论文施引文献
订阅此论文施引文献，注册后可以免费订阅5篇论文的施引文献，订阅后可以查看论文全部施引文献
1. Blending Accessibility in UI Framework Documentation to Build Awareness;The 25th International ACM SIGACCESS Conference on Computers and Accessibility;2023-10-22
2. Support for Long-Form Documentation Authoring and Maintenance;2023 IEEE Symposium on Visual Languages and Human-Centric Computing (VL/HCC);2023-10-03
3. Towards a taxonomy of Roxygen documentation in R packages;Empirical Software Engineering;2023-07
4. Improving API Knowledge Discovery with ML: A Case Study of Comparable API Methods;2023 IEEE/ACM 45th International Conference on Software Engineering (ICSE);2023-05
5. Reduce API Debugging Overhead via Knowledge Prepositioning;Companion Proceedings of the ACM Web Conference 2023;2023-04-30