Back to Search Start Over

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

Authors :
Thomchick, Richard
Source :
Proceedings of the Association for Information Science & Technology. 2018, Vol. 55 Issue 1, p908-910. 3p.
Publication Year :
2018

Abstract

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. [ABSTRACT FROM AUTHOR]

Details

Language :
English
ISSN :
23739231
Volume :
55
Issue :
1
Database :
Academic Search Index
Journal :
Proceedings of the Association for Information Science & Technology
Publication Type :
Conference
Accession number :
134431172
Full Text :
https://doi.org/10.1002/pra2.2018.14505501171