{"id":"https://openalex.org/W3117828107","doi":"https://doi.org/10.1109/tse.2020.3047088","title":"Requirements of API Documentation: A Case Study into Computer Vision Services","display_name":"Requirements of API Documentation: A Case Study into Computer Vision Services","publication_year":2020,"publication_date":"2020-12-24","ids":{"openalex":"https://openalex.org/W3117828107","doi":"https://doi.org/10.1109/tse.2020.3047088","mag":"3117828107"},"language":"en","primary_location":{"id":"doi:10.1109/tse.2020.3047088","is_oa":false,"landing_page_url":"https://doi.org/10.1109/tse.2020.3047088","pdf_url":null,"source":{"id":"https://openalex.org/S8351582","display_name":"IEEE Transactions on Software Engineering","issn_l":"0098-5589","issn":["0098-5589","1939-3520","2326-3881"],"is_oa":false,"is_in_doaj":false,"is_core":true,"host_organization":"https://openalex.org/P4310320439","host_organization_name":"IEEE Computer Society","host_organization_lineage":["https://openalex.org/P4310320439","https://openalex.org/P4310319808"],"host_organization_lineage_names":["IEEE Computer Society","Institute of Electrical and Electronics Engineers"],"type":"journal"},"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"IEEE Transactions on Software Engineering","raw_type":"journal-article"},"type":"article","indexed_in":["arxiv","crossref"],"open_access":{"is_oa":true,"oa_status":"green","oa_url":"https://arxiv.org/pdf/2012.13728","any_repository_has_fulltext":true},"authorships":[{"author_position":"first","author":{"id":"https://openalex.org/A5075031745","display_name":"Alex Cummaudo","orcid":"https://orcid.org/0000-0001-7878-6283"},"institutions":[{"id":"https://openalex.org/I149704539","display_name":"Deakin University","ror":"https://ror.org/02czsnj07","country_code":"AU","type":"education","lineage":["https://openalex.org/I149704539"]}],"countries":["AU"],"is_corresponding":false,"raw_author_name":"Alex Cummaudo","raw_affiliation_strings":["Applied Artificial Intelligence Institute, Deakin University, Geelong, VIC, Australia"],"raw_orcid":"https://orcid.org/0000-0001-7878-6283","affiliations":[{"raw_affiliation_string":"Applied Artificial Intelligence Institute, Deakin University, Geelong, VIC, Australia","institution_ids":["https://openalex.org/I149704539"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5030486012","display_name":"Rajesh Vasa","orcid":"https://orcid.org/0000-0003-4805-1467"},"institutions":[{"id":"https://openalex.org/I149704539","display_name":"Deakin University","ror":"https://ror.org/02czsnj07","country_code":"AU","type":"education","lineage":["https://openalex.org/I149704539"]}],"countries":["AU"],"is_corresponding":false,"raw_author_name":"Rajesh Vasa","raw_affiliation_strings":["Applied Artificial Intelligence Institute, Deakin University, Geelong, VIC, Australia"],"raw_orcid":"https://orcid.org/0000-0003-4805-1467","affiliations":[{"raw_affiliation_string":"Applied Artificial Intelligence Institute, Deakin University, Geelong, VIC, Australia","institution_ids":["https://openalex.org/I149704539"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5082913979","display_name":"John Grundy","orcid":"https://orcid.org/0000-0003-4928-7076"},"institutions":[{"id":"https://openalex.org/I56590836","display_name":"Monash University","ror":"https://ror.org/02bfwt286","country_code":"AU","type":"education","lineage":["https://openalex.org/I56590836"]}],"countries":["AU"],"is_corresponding":false,"raw_author_name":"John Grundy","raw_affiliation_strings":["Faculty of Information Technology, Monash University, Clayton, VIC, Australia"],"raw_orcid":"https://orcid.org/0000-0003-4928-7076","affiliations":[{"raw_affiliation_string":"Faculty of Information Technology, Monash University, Clayton, VIC, Australia","institution_ids":["https://openalex.org/I56590836"]}]},{"author_position":"last","author":{"id":"https://openalex.org/A5068173669","display_name":"Mohamed Abdelrazek","orcid":"https://orcid.org/0000-0003-3812-9785"},"institutions":[{"id":"https://openalex.org/I149704539","display_name":"Deakin University","ror":"https://ror.org/02czsnj07","country_code":"AU","type":"education","lineage":["https://openalex.org/I149704539"]}],"countries":["AU"],"is_corresponding":false,"raw_author_name":"Mohamed Abdelrazek","raw_affiliation_strings":["School of Information Technology, Deakin University, Geelong, VIC, Australia"],"raw_orcid":"https://orcid.org/0000-0003-3812-9785","affiliations":[{"raw_affiliation_string":"School of Information Technology, Deakin University, Geelong, VIC, Australia","institution_ids":["https://openalex.org/I149704539"]}]}],"institutions":[],"countries_distinct_count":1,"institutions_distinct_count":2,"corresponding_author_ids":[],"corresponding_institution_ids":[],"apc_list":null,"apc_paid":null,"fwci":1.0884,"has_fulltext":false,"cited_by_count":8,"citation_normalized_percentile":{"value":0.84989509,"is_in_top_1_percent":false,"is_in_top_10_percent":false},"cited_by_percentile_year":{"min":89,"max":97},"biblio":{"volume":"48","issue":"6","first_page":"2010","last_page":"2027"},"is_retracted":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9994000196456909,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},"topics":[{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9994000196456909,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T12127","display_name":"Software System Performance and Reliability","score":0.9986000061035156,"subfield":{"id":"https://openalex.org/subfields/1705","display_name":"Computer Networks and Communications"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}},{"id":"https://openalex.org/T10430","display_name":"Software Engineering Techniques and Practices","score":0.9812999963760376,"subfield":{"id":"https://openalex.org/subfields/1710","display_name":"Information Systems"},"field":{"id":"https://openalex.org/fields/17","display_name":"Computer Science"},"domain":{"id":"https://openalex.org/domains/3","display_name":"Physical Sciences"}}],"keywords":[{"id":"https://openalex.org/keywords/documentation","display_name":"Documentation","score":0.9081932306289673},{"id":"https://openalex.org/keywords/computer-science","display_name":"Computer science","score":0.7577551603317261},{"id":"https://openalex.org/keywords/application-programming-interface","display_name":"Application programming interface","score":0.624401330947876},{"id":"https://openalex.org/keywords/world-wide-web","display_name":"World Wide Web","score":0.5496091842651367},{"id":"https://openalex.org/keywords/software-engineering","display_name":"Software engineering","score":0.5019524097442627},{"id":"https://openalex.org/keywords/software","display_name":"Software","score":0.4971640408039093},{"id":"https://openalex.org/keywords/software-documentation","display_name":"Software documentation","score":0.4872254431247711},{"id":"https://openalex.org/keywords/cloud-computing","display_name":"Cloud computing","score":0.46440860629081726},{"id":"https://openalex.org/keywords/software-development","display_name":"Software development","score":0.33740735054016113},{"id":"https://openalex.org/keywords/software-development-process","display_name":"Software development process","score":0.2316093146800995},{"id":"https://openalex.org/keywords/operating-system","display_name":"Operating system","score":0.08299770951271057}],"concepts":[{"id":"https://openalex.org/C56666940","wikidata":"https://www.wikidata.org/wiki/Q788790","display_name":"Documentation","level":2,"score":0.9081932306289673},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.7577551603317261},{"id":"https://openalex.org/C99613125","wikidata":"https://www.wikidata.org/wiki/Q165194","display_name":"Application programming interface","level":2,"score":0.624401330947876},{"id":"https://openalex.org/C136764020","wikidata":"https://www.wikidata.org/wiki/Q466","display_name":"World Wide Web","level":1,"score":0.5496091842651367},{"id":"https://openalex.org/C115903868","wikidata":"https://www.wikidata.org/wiki/Q80993","display_name":"Software engineering","level":1,"score":0.5019524097442627},{"id":"https://openalex.org/C2777904410","wikidata":"https://www.wikidata.org/wiki/Q7397","display_name":"Software","level":2,"score":0.4971640408039093},{"id":"https://openalex.org/C81587897","wikidata":"https://www.wikidata.org/wiki/Q181702","display_name":"Software documentation","level":5,"score":0.4872254431247711},{"id":"https://openalex.org/C79974875","wikidata":"https://www.wikidata.org/wiki/Q483639","display_name":"Cloud computing","level":2,"score":0.46440860629081726},{"id":"https://openalex.org/C529173508","wikidata":"https://www.wikidata.org/wiki/Q638608","display_name":"Software development","level":3,"score":0.33740735054016113},{"id":"https://openalex.org/C180152950","wikidata":"https://www.wikidata.org/wiki/Q2904257","display_name":"Software development process","level":4,"score":0.2316093146800995},{"id":"https://openalex.org/C111919701","wikidata":"https://www.wikidata.org/wiki/Q9135","display_name":"Operating system","level":1,"score":0.08299770951271057}],"mesh":[],"locations_count":4,"locations":[{"id":"doi:10.1109/tse.2020.3047088","is_oa":false,"landing_page_url":"https://doi.org/10.1109/tse.2020.3047088","pdf_url":null,"source":{"id":"https://openalex.org/S8351582","display_name":"IEEE Transactions on Software Engineering","issn_l":"0098-5589","issn":["0098-5589","1939-3520","2326-3881"],"is_oa":false,"is_in_doaj":false,"is_core":true,"host_organization":"https://openalex.org/P4310320439","host_organization_name":"IEEE Computer Society","host_organization_lineage":["https://openalex.org/P4310320439","https://openalex.org/P4310319808"],"host_organization_lineage_names":["IEEE Computer Society","Institute of Electrical and Electronics Engineers"],"type":"journal"},"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"IEEE Transactions on Software Engineering","raw_type":"journal-article"},{"id":"pmh:oai:arXiv.org:2012.13728","is_oa":true,"landing_page_url":"http://arxiv.org/abs/2012.13728","pdf_url":"https://arxiv.org/pdf/2012.13728","source":{"id":"https://openalex.org/S4306400194","display_name":"arXiv (Cornell University)","issn_l":null,"issn":null,"is_oa":true,"is_in_doaj":false,"is_core":false,"host_organization":"https://openalex.org/I205783295","host_organization_name":"Cornell University","host_organization_lineage":["https://openalex.org/I205783295"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":"text"},{"id":"pmh:oai:dro.deakin.edu.au:DU:30147441","is_oa":false,"landing_page_url":null,"pdf_url":null,"source":{"id":"https://openalex.org/S4306401102","display_name":"Own your potential (DEAKIN)","issn_l":null,"issn":null,"is_oa":false,"is_in_doaj":false,"is_core":false,"host_organization":"https://openalex.org/I149704539","host_organization_name":"Deakin University","host_organization_lineage":["https://openalex.org/I149704539"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":"","raw_type":"Journal Article"},{"id":"pmh:oai:figshare.com:article/20678627","is_oa":true,"landing_page_url":"https://figshare.com/articles/journal_contribution/Requirements_of_API_Documentation_A_Case_Study_into_Computer_Vision_Services/20678627","pdf_url":null,"source":{"id":"https://openalex.org/S4377196282","display_name":"Figshare","issn_l":null,"issn":null,"is_oa":false,"is_in_doaj":false,"is_core":false,"host_organization":"https://openalex.org/I4210132348","host_organization_name":"Figshare (United Kingdom)","host_organization_lineage":["https://openalex.org/I4210132348"],"host_organization_lineage_names":[],"type":"repository"},"license":"cc-by","license_id":"https://openalex.org/licenses/cc-by","version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":"Text"}],"best_oa_location":{"id":"pmh:oai:arXiv.org:2012.13728","is_oa":true,"landing_page_url":"http://arxiv.org/abs/2012.13728","pdf_url":"https://arxiv.org/pdf/2012.13728","source":{"id":"https://openalex.org/S4306400194","display_name":"arXiv (Cornell University)","issn_l":null,"issn":null,"is_oa":true,"is_in_doaj":false,"is_core":false,"host_organization":"https://openalex.org/I205783295","host_organization_name":"Cornell University","host_organization_lineage":["https://openalex.org/I205783295"],"host_organization_lineage_names":[],"type":"repository"},"license":null,"license_id":null,"version":"submittedVersion","is_accepted":false,"is_published":false,"raw_source_name":null,"raw_type":"text"},"sustainable_development_goals":[{"id":"https://metadata.un.org/sdg/9","display_name":"Industry, innovation and infrastructure","score":0.6100000143051147}],"awards":[],"funders":[],"has_content":{"pdf":false,"grobid_xml":false},"content_urls":null,"referenced_works_count":65,"referenced_works":["https://openalex.org/W4214443","https://openalex.org/W19399978","https://openalex.org/W154166809","https://openalex.org/W171406816","https://openalex.org/W1493852950","https://openalex.org/W1566585837","https://openalex.org/W1602028541","https://openalex.org/W1969429349","https://openalex.org/W1988264842","https://openalex.org/W1990693033","https://openalex.org/W1991613282","https://openalex.org/W2006580360","https://openalex.org/W2008107570","https://openalex.org/W2014817805","https://openalex.org/W2016650943","https://openalex.org/W2034628356","https://openalex.org/W2035042871","https://openalex.org/W2052281826","https://openalex.org/W2063085086","https://openalex.org/W2063086899","https://openalex.org/W2065818484","https://openalex.org/W2073875337","https://openalex.org/W2103177132","https://openalex.org/W2112198760","https://openalex.org/W2118328848","https://openalex.org/W2123333323","https://openalex.org/W2128961774","https://openalex.org/W2143445997","https://openalex.org/W2155243985","https://openalex.org/W2162300032","https://openalex.org/W2164777277","https://openalex.org/W2252211299","https://openalex.org/W2395092677","https://openalex.org/W2470712504","https://openalex.org/W2513125375","https://openalex.org/W2574271863","https://openalex.org/W2582743722","https://openalex.org/W2608583225","https://openalex.org/W2613159689","https://openalex.org/W2735864825","https://openalex.org/W2739693438","https://openalex.org/W2767563557","https://openalex.org/W2773763890","https://openalex.org/W2794744449","https://openalex.org/W2888940765","https://openalex.org/W2896566650","https://openalex.org/W2908265642","https://openalex.org/W2955439455","https://openalex.org/W2980990204","https://openalex.org/W2992625786","https://openalex.org/W3013745307","https://openalex.org/W3091048166","https://openalex.org/W3123164564","https://openalex.org/W3123186970","https://openalex.org/W4213388807","https://openalex.org/W4229496713","https://openalex.org/W4244946961","https://openalex.org/W4244994171","https://openalex.org/W4245013494","https://openalex.org/W4246085474","https://openalex.org/W4247280291","https://openalex.org/W4289219086","https://openalex.org/W4297802021","https://openalex.org/W4399547459","https://openalex.org/W6754279747"],"related_works":["https://openalex.org/W1975647310","https://openalex.org/W2033083755","https://openalex.org/W2884925033","https://openalex.org/W2070076995","https://openalex.org/W2764664989","https://openalex.org/W2955439455","https://openalex.org/W2411980894","https://openalex.org/W4244946961","https://openalex.org/W2915114672","https://openalex.org/W2073875337"],"abstract_inverted_index":{"Using":[0],"cloud-based":[1],"computer":[2,143],"vision":[3,144],"services":[4],"is":[5,46,58],"gaining":[6],"traction,":[7],"where":[8,157,169],"developers":[9,106],"access":[10],"AI-powered":[11],"components":[12],"through":[13,136],"familiar":[14,37],"RESTful":[15],"APIs,":[16],"not":[17,47,134,164],"needing":[18],"to":[19,38,50,90,110,122,176,187],"orchestrate":[20],"large":[21],"training":[22,28],"and":[23,44,167,195],"inference":[24],"infrastructures":[25],"or":[26,132],"curate/label":[27],"datasets.":[29],"However,":[30],"while":[31],"these":[32,54,128],"APIs":[33],"<italic":[34,118],"xmlns:mml=\"http://www.w3.org/1998/Math/MathML\"":[35,119],"xmlns:xlink=\"http://www.w3.org/1999/xlink\">seem</i>":[36],"use,":[39],"their":[40,179],"non-deterministic":[41],"run-time":[42],"behaviour":[43],"evolution":[45],"adequately":[48],"communicated":[49],"developers.":[51],"Therefore,":[52],"improving":[53],"services\u2019":[55],"API":[56,76,93,113,160],"documentation":[57,61,77,114,161,191],"paramount\u2014more":[59],"extensive":[60],"facilitates":[62],"the":[63,141,153,196],"development":[64],"process":[65],"of":[66,86,107,117,127,159,185],"intelligent":[67,189],"software.":[68],"In":[69],"a":[70,84,137,183],"prior":[71],"study,":[72],"we":[73],"extracted":[74],"34":[75],"artefacts":[78,115,130,175],"from":[79],"21":[80],"seminal":[81],"works,":[82],"devising":[83],"taxonomy":[85],"five":[87],"key":[88],"requirements":[89],"produce":[91],"quality":[92],"documentation.":[94],"We":[95,147,181],"extend":[96],"this":[97],"study":[98,139],"in":[99,140,152],"two":[100],"ways.":[101],"First,":[102],"by":[103],"surveying":[104],"104":[105],"varying":[108],"experience":[109],"understand":[111],"what":[112],"are":[116,131,133],"xmlns:xlink=\"http://www.w3.org/1999/xlink\">most":[120],"value</i>":[121],"practitioners.":[123],"Second,":[124],"identifying":[125],"which":[126],"highly-valued":[129],"well-documented":[135],"case":[138],"emerging":[142],"service":[145],"domain.":[146],"identify:":[148],"(i)":[149],"several":[150],"gaps":[151],"software":[154,190],"engineering":[155],"literature,":[156],"aspects":[158],"understanding":[162],"is/is":[163],"extensively":[165],"investigated;":[166],"(ii)":[168],"industry":[170],"vendors":[171,194],"(in":[172],"contrast)":[173],"document":[174],"better":[177],"serve":[178],"end-developers.":[180],"provide":[182],"set":[184],"recommendations":[186],"enhance":[188],"for":[192],"both":[193],"wider":[197],"research":[198],"community.":[199]},"counts_by_year":[{"year":2025,"cited_by_count":2},{"year":2024,"cited_by_count":2},{"year":2022,"cited_by_count":3},{"year":2021,"cited_by_count":1}],"updated_date":"2025-11-06T03:46:38.306776","created_date":"2025-10-10T00:00:00"}