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 条
  • [31] MisuseHint: A Service for API Misuse Detection Based on Building Knowledge Graph from Documentation and Codebase
    Liang, Qingmi
    Kuai, Zhirui
    Zhang, Yangqi
    Zhang, Zhiyang
    Kuang, Li
    Zhang, Lingyan
    2022 IEEE INTERNATIONAL CONFERENCE ON WEB SERVICES (IEEE ICWS 2022), 2022, : 246 - 255
  • [32] Improving Pediatric Nurses' Knowledge, Accuracy, and Confidence Through Code Documentation Simulation
    Sapyta, Ying Ying
    Eiger, Carmel
    CLINICAL SIMULATION IN NURSING, 2017, 13 (06) : 278 - 283
  • [33] Improving hardware/software interface management in systems of systems through documentation as code
    Cadavid, Hector
    Andrikopoulos, Vasilios
    Avgeriou, Paris
    EMPIRICAL SOFTWARE ENGINEERING, 2023, 28 (04)
  • [34] Improving hardware/software interface management in systems of systems through documentation as code
    Héctor Cadavid
    Vasilios Andrikopoulos
    Paris Avgeriou
    Empirical Software Engineering, 2023, 28
  • [35] Improving Collaboration Efficiency Between UX/UI Designers and Developers in a Low-Code Platform
    Pacheco, Joao
    Garbatov, Stoyan
    Goulao, Miguel
    24TH ACM/IEEE INTERNATIONAL CONFERENCE ON MODEL-DRIVEN ENGINEERING LANGUAGES AND SYSTEMS COMPANION (MODELS-C 2021), 2021, : 140 - 149
  • [36] ASSISTING DEVELOPERS TO BUILD HIGH-QUALITY CODE-FIRST WEB SERVICE APIS
    Manuel Roriguez, Juan
    Mateos, Cristian
    Zunino, Alejandro
    JOURNAL OF WEB ENGINEERING, 2015, 14 (3-4): : 251 - 285
  • [37] Training and Technology: Improving the Quality and Timeliness of Service Plans and Case Documentation
    Reilly, Susan H.
    McKelvey-Walsh, Nicole
    Freundlich, Madelyn
    Brenner, Eliot
    ADMINISTRATION IN SOCIAL WORK, 2011, 35 (02): : 207 - 222
  • [38] An HDL Simulator with Direct Register Access for Improving Code Coverage
    Isawa, Ryoichi
    Kanaya, Nobuyuki
    Fujiwara, Yoshitada
    Takehisa, Tatsuya
    Ushimaru, Hayato
    Arisue, Dai
    Makita, Daisuke
    Mimura, Satoshi
    Inoue, Daisuke
    2022 17TH ASIA JOINT CONFERENCE ON INFORMATION SECURITY, ASIAJCIS, 2022, : 49 - 55
  • [39] Increasing Access to Justice by Improving Usability of Statutory Code Websites*
    Darvil, Kathleen
    LAW LIBRARY JOURNAL, 2023, 115 (01): : 123 - 178
  • [40] KG2Code: Correct Code Examples Mining Service Based on Knowledge Graph for Fixing API Misuses
    Zhang, Yangqi
    Kuai, Zhirui
    Yao, Wenjin
    Zhang, Zhiyang
    Kuang, Li
    SERVICE-ORIENTED COMPUTING (ICSOC 2021), 2021, 13121 : 875 - 882