{"status":"ok","message-type":"work","message-version":"1.0.0","message":{"indexed":{"date-parts":[[2026,6,10]],"date-time":"2026-06-10T15:49:34Z","timestamp":1781106574809,"version":"3.54.1"},"reference-count":18,"publisher":"IGI Global Scientific Publishing","issue":"1","content-domain":{"domain":[],"crossmark-restriction":false},"short-container-title":[],"published-print":{"date-parts":[[2010,1,1]]},"abstract":"<p>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 \u201cend-user developers.\u201d Our study showed that the participants\u2019 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.<\/p>","DOI":"10.4018\/joeuc.2010101903","type":"journal-article","created":{"date-parts":[[2011,2,15]],"date-time":"2011-02-15T14:46:17Z","timestamp":1297781177000},"page":"23-51","source":"Crossref","is-referenced-by-count":10,"title":["Studying the Documentation of an API for Enterprise Service-Oriented Architecture"],"prefix":"10.4018","volume":"22","author":[{"given":"Brad A.","family":"Myers","sequence":"first","affiliation":[{"name":"Carnegie Mellon University, USA"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Sae Young","family":"Jeong","sequence":"additional","affiliation":[{"name":"Carnegie Mellon University, USA"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Yingyu","family":"Xie","sequence":"additional","affiliation":[{"name":"Carnegie Mellon University, USA"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Jack","family":"Beaton","sequence":"additional","affiliation":[{"name":"Nokia, Inc., USA"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Jeff","family":"Stylos","sequence":"additional","affiliation":[{"name":"Carnegie Mellon University, USA"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Ralf","family":"Ehret","sequence":"additional","affiliation":[{"name":"SAP AG, Germany"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Jan","family":"Karstens","sequence":"additional","affiliation":[{"name":"SAP AG, Germany"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Arkin","family":"Efeoglu","sequence":"additional","affiliation":[{"name":"SAP AG, Germany"}],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Daniela K.","family":"Busse","sequence":"additional","affiliation":[{"name":"SAP Labs LLC, USA"}],"role":[{"vocabulary":"crossref","role":"author"}]}],"member":"2432","reference":[{"key":"joeuc.2010101903-0","doi-asserted-by":"crossref","unstructured":"Beaton, J., Jeong, S. Y., Xie, Y., Stylos, J., & Myers, B. A. (2008, September 15-19). Usability challenges for enterprise service-oriented architecture APIs. In Proceedings of the the 2008 IEEE Symposium on Visual Languages and Human-Centric Computing (VL\/HCC\u201908), Herrsching am Ammersee, Germany (pp. 193-196). Washington, DC: IEEE Computer Society.","DOI":"10.1109\/VLHCC.2008.4639084"},{"key":"joeuc.2010101903-1","doi-asserted-by":"crossref","unstructured":"Beaton, J., Myers, B. A., Stylos, J., Jeong, S. Y., & Xie, Y. (2008). Usability evaluation for enterprise SOA APIs. In Proceedings of the 2nd International Workshop on Systems Development in SOA Environments (SDSOA 2008, ICSE 2008), Leipzig, Germany, (pp. 29-34). ACM Publishing.","DOI":"10.1145\/1370916.1370924"},{"key":"joeuc.2010101903-2","unstructured":"Bloch, J. (2001). Effective java programming language guide. Reading, MA: Addison-Wesley."},{"key":"joeuc.2010101903-3","unstructured":"Clarke, S. (2004). Measuring API usability. Dr. Dobb's Journal, May 2004, S6-S9."},{"key":"joeuc.2010101903-4","unstructured":"Cwalina, K., & Abrams, B. (2005). Framework design guidelines. Upper-Saddle River, NJ: Addison-Wesley."},{"key":"joeuc.2010101903-5","doi-asserted-by":"crossref","unstructured":"Ellis, B., Stylos, J., & Myers, B. (2007, May 19-27). The factory pattern in API design: A usability evaluation. In Proceedings of the 29th International Conference on Software Engineering (ICSE 2007), Minneapolis, MN (pp. 302-312). Washington, DC: IEEE Computer Society.","DOI":"10.1109\/ICSE.2007.85"},{"key":"joeuc.2010101903-6","doi-asserted-by":"crossref","unstructured":"Forward, A., & Lethbridge, T. C. (2002, November 8-9). The relevance of software documentation, tools, and technology: A survey. In Proceedings of DocEng 2002, McLean, VA (pp. 26-33). ACM Publishing.","DOI":"10.1145\/585058.585065"},{"key":"joeuc.2010101903-7","doi-asserted-by":"crossref","unstructured":"Friendly, L. (1995, June 1-2). The design of distributed hyperlinked programming documentation. In Proceedings of the International Workshop on Hypermedia Design, Montpellier, France, (pp. 151-173). London: Springer.","DOI":"10.1007\/978-1-4471-3082-6_17"},{"key":"joeuc.2010101903-8","unstructured":"Jones, S. (2006). SOA anti-patterns. Retrieved from http:\/\/www.infoq.com\/articles\/SOA-anti-patterns"},{"key":"joeuc.2010101903-9","doi-asserted-by":"crossref","unstructured":"Ko, A. J., Myers, B. A., & Aung, H. H. (2004, September 26-29). Six learning barriers in end-user programming systems. In Proceedings of the IEEE Symposium on Visual Languages and Human-Centric Computing, Rome, Italy (pp. 199-206). Washington, DC: IEEE Computer Society.","DOI":"10.1109\/VLHCC.2004.47"},{"key":"joeuc.2010101903-10","doi-asserted-by":"publisher","DOI":"10.1145\/1015864.1015888"},{"key":"joeuc.2010101903-11","doi-asserted-by":"crossref","unstructured":"Nielsen, J. (1993). Usability engineering. Boston: Academic Press.","DOI":"10.1016\/B978-0-08-052029-2.50009-7"},{"key":"joeuc.2010101903-12","unstructured":"Purho, V. (2000). Heuristic inspections for documentation-10 recommended documentation heuristics. STC Usability SIG Newsletter, 6(4)."},{"key":"joeuc.2010101903-13","doi-asserted-by":"crossref","unstructured":"Stylos, J., Busse, D. K., Graf, B., Ziegler, C., Ehret, R., & Karstens, J. (2008, September 15-19). A case study of API design for improved usability. In Proceedings of the the 2008 IEEE Symposium on Visual Languages and Human-Centric Computing (VL\/HCC\u201908), Herrsching am Ammersee, Germany (pp. 189-192). Washington, DC: IEEE Computer Society.","DOI":"10.1109\/VLHCC.2008.4639083"},{"key":"joeuc.2010101903-14","doi-asserted-by":"crossref","unstructured":"Stylos, J., & Clarke, S. (2007, May 19-27). Usability implications of requiring parameters in objects' constructors. In Proceedings of the 29th International Conference on Software Engineering (ICSE 2007), Minneapolis, MN (pp. 529-539). Washington, DC: IEEE Computer Society.","DOI":"10.1109\/ICSE.2007.92"},{"key":"joeuc.2010101903-15","doi-asserted-by":"crossref","unstructured":"Stylos, J., Faulring, A., Yang, Z., & Myers, B. A. (2009, September 20-24). Improving API documentation using API usage information. Paper presented at the 2009 IEEE Symposium on Visual Languages and Human-Centric Computing (VL\/HCC'09), Corvallis, OR. (pp. 119-126).","DOI":"10.1109\/VLHCC.2009.5295283"},{"key":"joeuc.2010101903-16","doi-asserted-by":"crossref","unstructured":"Stylos, J., & Myers., B. A. (2008, November 9-14). The implications of method placement on API learnability. In Proceedings of the 16th ACM SIGSOFT Symposium on Foundations of Software Engineering (FSE 2008), Atlanta, GA (pp. 105-112). ACM Publishing.","DOI":"10.1145\/1453101.1453117"},{"key":"joeuc.2010101903-17","unstructured":"Wulf, V., Paterno, F., & Lieberman, H. (Eds.). (2006). End user development. New York: Springer."}],"container-title":["Journal of Organizational and End User Computing"],"original-title":[],"language":"ng","link":[{"URL":"https:\/\/www.igi-global.com\/viewtitle.aspx?TitleId=39119","content-type":"unspecified","content-version":"vor","intended-application":"similarity-checking"}],"deposited":{"date-parts":[[2022,6,1]],"date-time":"2022-06-01T13:47:06Z","timestamp":1654091226000},"score":1,"resource":{"primary":{"URL":"https:\/\/services.igi-global.com\/resolvedoi\/resolve.aspx?doi=10.4018\/joeuc.2010101903"}},"subtitle":[""],"short-title":[],"issued":{"date-parts":[[2010,1,1]]},"references-count":18,"journal-issue":{"issue":"1","published-print":{"date-parts":[[2010,1]]}},"URL":"https:\/\/doi.org\/10.4018\/joeuc.2010101903","relation":{},"ISSN":["1546-2234","1546-5012"],"issn-type":[{"value":"1546-2234","type":"print"},{"value":"1546-5012","type":"electronic"}],"subject":[],"published":{"date-parts":[[2010,1,1]]}}}