Improving access to API documentation for developers with Docs-as-Code-as-a-service

被引:3
|
作者
Thomchick R. [1 ]
机构
[1] VMware, Inc.
关键词
API; Context Switching; Developer; Docs-as-Code; Documentation; SaaS; Traceability;
D O I
10.1002/pra2.2018.14505501171
中图分类号
学科分类号
摘要
Web Application Programming Interfaces (APIs) provide the connective tissue that developers need to integrate Internet services and create “software-as-a-service” (SaaS) applications. To learn an API's usage, developers often turn to their web browsers to access documentation and try out APIs. However, traditional approaches to documentation present obstacles that can hamper API comprehension and developer productivity. To overcome these obstacles, practitioners are adopting a new approach called Docs-as-Code, in which documents are published with many of the same tools and practices used to deploy source code. In this paper, we present Dev Center, a system based in part on the Docs-as-Code framework and designed to provide ubiquitous access to a broad set of API documentation resources. Preliminary findings suggest that Dev Center could potentially improve API comprehension and developer productivity, while Docs-as-Code could benefit related research efforts. Copyright © 2018 by Association for Information Science and Technology
引用
收藏
页码:908 / 910
页数:2
相关论文
共 50 条
  • [1] Evaluating Code Comment Generation with Summarized API Docs
    Matmti, Bilel
    Fard, Fatemeh
    Proceedings - 2023 IEEE/ACM 2nd International Workshop on Natural Language-Based Software Engineering, NLBSE 2023, 2023, : 60 - 63
  • [2] Evaluating Code Comment Generation With Summarized API Docs
    Matmti, Bilel
    Fard, Fatemeh
    2023 IEEE/ACM 2ND INTERNATIONAL WORKSHOP ON NATURAL LANGUAGE-BASED SOFTWARE ENGINEERING, NLBSE, 2023, : 60 - 63
  • [3] Why API documentation is insufficient for developers: an empirical study
    Qiang Fan
    Yue Yu
    Tao Wang
    Gang Yin
    Huaimin Wang
    Science China Information Sciences, 2021, 64
  • [4] Why API documentation is insufficient for developers: an empirical study
    Fan, Qiang
    Yu, Yue
    Wang, Tao
    Yin, Gang
    Wang, Huaimin
    SCIENCE CHINA-INFORMATION SCIENCES, 2021, 64 (01)
  • [5] Why API documentation is insufficient for developers: an empirical study
    Qiang FAN
    Yue YU
    Tao WANG
    Gang YIN
    Huaimin WANG
    Science China(Information Sciences), 2021, 64 (01) : 248 - 250
  • [6] Improving API Documentation Using API Usage Information
    Stylos, Jeffrey
    Faulring, Andrew
    Yang, Zizhuang
    Myers, Brad A.
    2009 IEEE SYMPOSIUM ON VISUAL LANGUAGES AND HUMAN-CENTRIC COMPUTING, PROCEEDINGS, 2009, : 119 - 126
  • [7] An API Learning Service for Inexperienced Developers Based on API Knowledge Graph
    Yin, Hang
    Zheng, Yuanhao
    Sun, Yanchun
    Huang, Gang
    2021 IEEE INTERNATIONAL CONFERENCE ON WEB SERVICES, ICWS 2021, 2021, : 251 - 261
  • [8] What should developers be aware of? An empirical study on the directives of API documentation
    Monperrus, Martin
    Eichberg, Michael
    Tekes, Elif
    Mezini, Mira
    EMPIRICAL SOFTWARE ENGINEERING, 2012, 17 (06) : 703 - 737
  • [9] What should developers be aware of? An empirical study on the directives of API documentation
    Martin Monperrus
    Michael Eichberg
    Elif Tekes
    Mira Mezini
    Empirical Software Engineering, 2012, 17 : 703 - 737
  • [10] API Blindspots: Why Experienced Developers Write Vulnerable Code
    Oliveira, Daniela Seabra
    Lin, Tian
    Rahman, Muhammad Sajidur
    Akefirad, Rad
    Ellis, Donovan
    Perez, Eliany
    Bobhate, Rahul
    Delong, Lois A.
    Cappos, Justin
    Brun, Yuriy
    Ebner, Natalie C.
    PROCEEDINGS OF THE FOURTEENTH SYMPOSIUM ON USABLE PRIVACY AND SECURITY, 2018, : 315 - 328