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
23 articles.
订阅此论文施引文献
订阅此论文施引文献，注册后可以免费订阅5篇论文的施引文献，订阅后可以查看论文全部施引文献
1. Do LLMs Meet the Needs of Software Tutorial Writers? Opportunities and Design Implications;Designing Interactive Systems Conference;2024-07
2. Understanding Documentation Use Through Log Analysis: A Case Study of Four Cloud Services;Proceedings of the CHI Conference on Human Factors in Computing Systems;2024-05-11
3. Using an LLM to Help With Code Understanding;Proceedings of the IEEE/ACM 46th International Conference on Software Engineering;2024-04-12
4. Application Programming Interface with a Case Study of SOA;2023 International Conference on Integrated Intelligence and Communication Systems (ICIICS);2023-11-24
5. Blending Accessibility in UI Framework Documentation to Build Awareness;The 25th International ACM SIGACCESS Conference on Computers and Accessibility;2023-10-22