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 条
  • [21] A SOFTWARE SERVICE - DOCUMENTATION HOUSES ARE IMPROVING STANDARDS
    CARTER, M
    DATA PROCESSING, 1986, 28 (10): : 507 - 511
  • [22] Improving API Usage through Automatic Detection of Redundant Code
    Kawrykow, David
    Robillard, Martin P.
    2009 IEEE/ACM INTERNATIONAL CONFERENCE ON AUTOMATED SOFTWARE ENGINEERING, PROCEEDINGS, 2009, : 111 - 122
  • [23] core_api_client: An API for the CORE aggregation service for open access papers
    Vake, Domen
    Hrovatin, Niki
    Tosic, Aleksandar
    Vicic, Jernej
    SOFTWAREX, 2024, 28
  • [24] CLCDSA: Cross Language Code Clone Detection using Syntactical Features and API Documentation
    Nafi, Kawser Wazed
    Kar, Tonny Shekha
    Roy, Banani
    Roy, Chanchal K.
    Schneider, Kevin A.
    34TH IEEE/ACM INTERNATIONAL CONFERENCE ON AUTOMATED SOFTWARE ENGINEERING (ASE 2019), 2019, : 1026 - 1037
  • [25] SCAD service central automatise de documentation (Community documentation access system).
    Muehlfeld, K
    JOURNAL OF GOVERNMENT INFORMATION, 1998, 25 (04): : 378 - 381
  • [26] Improving Incidence of Code Status Documentation Through Process and Discipline
    Neubauer, Marcus A.
    Taniguchi, Cynthia B.
    Hoverman, J. Russell
    JOURNAL OF ONCOLOGY PRACTICE, 2015, 11 (02) : E263 - E266
  • [27] Improving Health Care Service Delivery with A National Code Service
    Vuokko, Riikka
    Makela-Bengs, Paivi
    Harkonen, Mikko
    E-HEALTH - FOR CONTINUITY OF CARE, 2014, 205 : 323 - 327
  • [28] Improving open data web API documentation through interactivity and natural language generation
    Gonzalez-Mora, Cesar
    Barros, Cristina
    Garrig, Irene
    Zubcoff, Jose
    Lloret, Elena
    Maz, Jose -Norberto
    COMPUTER STANDARDS & INTERFACES, 2023, 83
  • [29] Documentation of code status or advance directive in patients hospitalized to the neurology service
    Biondo, A
    Schuh, L
    NEUROLOGY, 2005, 64 (06) : A32 - A32
  • [30] APIContext2Com: Code Comment Generation by Incorporating Pre-Defined API Documentation
    Shahbazi, Ramin
    Fard, Fatemeh
    2023 IEEE/ACM 31ST INTERNATIONAL CONFERENCE ON PROGRAM COMPREHENSION, ICPC, 2023, : 13 - 24