Welcome to the InfoSci Platform
Reference Hub10
Studying the Documentation of an API for Enterprise Service-Oriented Architecture

Studying the Documentation of an API for Enterprise Service-Oriented Architecture

Brad A. Myers, Sae Young Jeong, Yingyu Xie, Jack Beaton, Jeff Stylos, Ralf Ehret, Jan Karstens, Arkin Efeoglu, Daniela K. Busse
Copyright: © 2010 |Volume: 22 |Issue: 1 |Pages: 29
ISSN: 1546-2234|EISSN: 1546-5012|ISSN: 1546-2234|EISBN13: 9781616929107|EISSN: 1546-5012|DOI: 10.4018/joeuc.2010101903
Cite Article Cite Article

MLA

Myers, Brad A., et al. "Studying the Documentation of an API for Enterprise Service-Oriented Architecture." JOEUC vol.22, no.1 2010: pp.23-51. http://doi.org/10.4018/joeuc.2010101903

APA

Myers, B. A., Jeong, S. Y., Xie, Y., Beaton, J., Stylos, J., Ehret, R., Karstens, J., Efeoglu, A., & Busse, D. K. (2010). Studying the Documentation of an API for Enterprise Service-Oriented Architecture. Journal of Organizational and End User Computing (JOEUC), 22(1), 23-51. http://doi.org/10.4018/joeuc.2010101903

Chicago

Myers, Brad A., et al. "Studying the Documentation of an API for Enterprise Service-Oriented Architecture," Journal of Organizational and End User Computing (JOEUC) 22, no.1: 23-51. http://doi.org/10.4018/joeuc.2010101903

Export Reference

Mendeley
Favorite Full-Issue Download

Abstract

All software today is written using application programming interfaces (APIs). We performed a user study of the online documentation of a large and complex API for Enterprise Service-Oriented Architecture (eSOA), which identified many issues and recommendations for making API documentation easier to use. eSOA is an appropriate testbed because the target users include high-level business experts who do not have significant programming expertise and thus can be classified as “end-user developers.” Our study showed that the participants’ background influenced how they navigated the documentation. Lack of familiarity with business terminology was a barrier for developers without business application experience. Both groups avoided areas of the documentation that had an inconsistent visual design. A new design for the documentation that supports flexible navigation strategies seems to be required to support the wide range of users for eSOA. This paper summarizes our study and provides recommendations for future documentation for APIs.

Request Access

You do not own this content. Please login to recommend this title to your institution's librarian or purchase it from the IGI Global bookstore.