How developers use API documentation: an observation study
How developers use API documentation: an observation study
复制标题
开发人员如何使用 API 文档：观察研究
DOI：
--
复制
发表时间：
2019
期刊：
影响因子：
--
通讯作者：
Andreas Schubert
中科院分区：
文献类型：
--
作者：
Michael Meng;Stephanie M. Steinhardt;Andreas Schubert
应用程序编程接口（API）在现代软件工程中起着至关重要的作用。然而，学习使用新的API对开发人员来说往往是一个挑战。为了有效地支持学习过程，我们需要了解开发人员在开始使用新的API时如何使用文档。我们报告了一项探索性研究，观察开发人员，而他们解决编程任务，涉及一个简单的API。结果揭示了开发人员活动和文档使用方面的差异，成功的API文档设计策略需要适应这些差异。讨论了优化API文档的几个指导原则。
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.