• 主题
高级搜索  >
历史搜索 清空历史
首页> 外文期刊>Journal of educational technology systems >Application Programming Interface Documentation: What Do Software Developers Want?
【24h】

Application Programming Interface Documentation: What Do Software Developers Want?

机译：应用程序编程接口文档：软件开发人员想要什么？

获取原文
获取原文并翻译 | 示例
           
页面导航
  • 摘要
  • 著录项
  • 相似文献
  • 相关主题

摘要

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.
机译：应用程序编程接口（API）的成功关键取决于其文档满足软件开发人员信息需求的程度。先前的研究表明，这些信息需求尚未得到足够的了解。本文介绍了一系列半结构化访谈的结果和一份后续问卷，以探讨软件开发人员的学习目标和学习策略，他们寻求的信息资源以及应用于API文档的质量标准。我们的结果表明，开发人员最初试图对API的总体目的和主要功能形成一种全局理解，但随后采用了API文档都需要解决的面向概念或面向代码的学习策略。我们的结果还表明，诸如完整性和清晰度之类的一般质量标准也与API文档相关。因此，开发和维护API文档需要涉及通信专业人员的专业知识。

著录项

相似文献

  • 外文文献
  • 中文文献
  • 专利
获取原文

客服邮箱：kefu@zhangqiaokeyan.com

京公网安备：11010802029741号 ICP备案号：京ICP备15016152号-6 六维联合信息科技 (北京) 有限公司©版权所有

  • 客服微信

  • 服务号