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 条
  • [41] A flexible access control service for Java']Java mobile code
    Corradi, A
    Montanari, R
    Lupu, E
    Sloman, M
    Stefanelli, C
    16TH ANNUAL COMPUTER SECURITY APPLICATIONS CONFERENCE, PROCEEDINGS, 2000, : 356 - 365
  • [42] Improving Documentation of Firearm Access During Pediatric Emergency Visits for Suicidal Ideation
    Kemal, Samaa
    Lennon, Tyler
    Simon, Norma-Jean
    Kaczor, Kim
    Hilliard, Mallory
    Corboy, Jacqueline B.
    Hoffmann, Jennifer A.
    PEDIATRICS, 2024, 153 (04)
  • [43] Improving access to urologists through an electronic consultation service
    Witherspoon, Luke
    Liddy, Clare
    Afkham, Amir
    Keely, Erin
    Mahoney, John
    CUAJ-CANADIAN UROLOGICAL ASSOCIATION JOURNAL, 2017, 11 (08): : 270 - 274
  • [45] Improving access to Hackney Integrated Learning Disability Service
    Omrani, Osama
    Spiers, Jessica
    Prior, David
    Haberland, Kirsty
    Kabir, Anwar
    Sinclair, Candace
    Woods, Tom
    Hall, Ian
    Checkley, Laura
    BMJ OPEN QUALITY, 2022, 11 (03)
  • [46] IMPROVING ACCESS TO CARE: A COLLOCATION MODEL OF SERVICE DELIVERY
    Lee, J.
    AUSTRALIAN AND NEW ZEALAND JOURNAL OF PSYCHIATRY, 2017, 51 : 49 - 49
  • [47] Improving Access to Rheumatologists: The Utilization and Benefits of an eConsultation Service
    Rostom, Krista
    Smith, Douglas
    Liddy, Claire
    Drosinis, Paul
    Keely, Erin
    JOURNAL OF RHEUMATOLOGY, 2015, 42 (07) : 1311 - 1311
  • [48] Block turbo code with binary input for improving quality of service
    Adde, P
    Pyndiah, R
    Kerouedan, S
    MULTIACCESS, MOBILITY AND TELETRAFFIC FOR WIRELESS COMMUNICATIONS, VOLUME 6, 2002, : 195 - 204
  • [49] Improving reflective practice: a documentation rubric for mentoring preservice and in-service teachers
    Edwards, Carolyn Pope
    Hamel, Erin
    Leeper Miller, Jennifer
    Ren, Lixin
    JOURNAL OF EARLY CHILDHOOD TEACHER EDUCATION, 2020, 41 (01) : 2 - 17
  • [50] A Security Weakness of the CDMA(Code Division Multiple Access) Cellular Service
    Ryu, Dae Hyun
    Jang, Seung Ju
    INTERNATIONAL JOURNAL OF COMPUTER SCIENCE AND NETWORK SECURITY, 2006, 6 (5B): : 218 - 227