{"id":"https://openalex.org/W3089582840","doi":"https://doi.org/10.1145/3380851.3416759","title":"Optimizing API Documentation","display_name":"Optimizing API Documentation","publication_year":2020,"publication_date":"2020-09-29","ids":{"openalex":"https://openalex.org/W3089582840","doi":"https://doi.org/10.1145/3380851.3416759","mag":"3089582840"},"language":"en","primary_location":{"id":"doi:10.1145/3380851.3416759","is_oa":true,"landing_page_url":"https://doi.org/10.1145/3380851.3416759","pdf_url":"https://dl.acm.org/doi/pdf/10.1145/3380851.3416759","source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"Proceedings of the 38th ACM International Conference on Design of Communication","raw_type":"proceedings-article"},"type":"article","indexed_in":["crossref"],"open_access":{"is_oa":true,"oa_status":"gold","oa_url":"https://dl.acm.org/doi/pdf/10.1145/3380851.3416759","any_repository_has_fulltext":null},"authorships":[{"author_position":"first","author":{"id":"https://openalex.org/A5041204981","display_name":"Michael Meng","orcid":"https://orcid.org/0000-0003-2100-648X"},"institutions":[{"id":"https://openalex.org/I2802534935","display_name":"Merseburg University of Applied Sciences","ror":"https://ror.org/04f8x5b20","country_code":"DE","type":"education","lineage":["https://openalex.org/I2802534935"]}],"countries":["DE"],"is_corresponding":true,"raw_author_name":"Michael Meng","raw_affiliation_strings":["Merseburg University of Applied Sciences"],"affiliations":[{"raw_affiliation_string":"Merseburg University of Applied Sciences","institution_ids":["https://openalex.org/I2802534935"]}]},{"author_position":"middle","author":{"id":"https://openalex.org/A5007391915","display_name":"Stephanie Steinhardt","orcid":null},"institutions":[{"id":"https://openalex.org/I2802534935","display_name":"Merseburg University of Applied Sciences","ror":"https://ror.org/04f8x5b20","country_code":"DE","type":"education","lineage":["https://openalex.org/I2802534935"]}],"countries":["DE"],"is_corresponding":false,"raw_author_name":"Stephanie M. Steinhardt","raw_affiliation_strings":["Merseburg University of Applied Sciences"],"affiliations":[{"raw_affiliation_string":"Merseburg University of Applied Sciences","institution_ids":["https://openalex.org/I2802534935"]}]},{"author_position":"last","author":{"id":"https://openalex.org/A5068024917","display_name":"Andreas Schubert","orcid":"https://orcid.org/0000-0002-7396-8413"},"institutions":[{"id":"https://openalex.org/I2802534935","display_name":"Merseburg University of Applied Sciences","ror":"https://ror.org/04f8x5b20","country_code":"DE","type":"education","lineage":["https://openalex.org/I2802534935"]}],"countries":["DE"],"is_corresponding":false,"raw_author_name":"Andreas Schubert","raw_affiliation_strings":["Merseburg University of Applied Sciences"],"affiliations":[{"raw_affiliation_string":"Merseburg University of Applied Sciences","institution_ids":["https://openalex.org/I2802534935"]}]}],"institutions":[],"countries_distinct_count":1,"institutions_distinct_count":3,"corresponding_author_ids":["https://openalex.org/A5041204981"],"corresponding_institution_ids":["https://openalex.org/I2802534935"],"apc_list":null,"apc_paid":null,"fwci":1.6662,"has_fulltext":true,"cited_by_count":8,"citation_normalized_percentile":{"value":0.8847879,"is_in_top_1_percent":false,"is_in_top_10_percent":false},"cited_by_percentile_year":{"min":89,"max":97},"biblio":{"volume":null,"issue":null,"first_page":"1","last_page":"11"},"is_retracted":false,"is_paratext":false,"is_xpac":false,"primary_topic":{"id":"https://openalex.org/T10260","display_name":"Software Engineering Research","score":0.9998999834060669,"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.9998999834060669,"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/T11675","display_name":"Open Source Software Innovations","score":0.9958999752998352,"subfield":{"id":"https://openalex.org/subfields/1706","display_name":"Computer Science Applications"},"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/T10639","display_name":"Advanced Software Engineering Methodologies","score":0.992900013923645,"subfield":{"id":"https://openalex.org/subfields/1702","display_name":"Artificial Intelligence"},"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.9766584634780884},{"id":"https://openalex.org/keywords/computer-science","display_name":"Computer science","score":0.6919786930084229},{"id":"https://openalex.org/keywords/internal-documentation","display_name":"Internal documentation","score":0.6396186351776123},{"id":"https://openalex.org/keywords/software-documentation","display_name":"Software documentation","score":0.5871769785881042},{"id":"https://openalex.org/keywords/technical-documentation","display_name":"Technical documentation","score":0.5520784854888916},{"id":"https://openalex.org/keywords/test","display_name":"Test (biology)","score":0.5456157922744751},{"id":"https://openalex.org/keywords/set","display_name":"Set (abstract data type)","score":0.5446592569351196},{"id":"https://openalex.org/keywords/empirical-research","display_name":"Empirical research","score":0.48764193058013916},{"id":"https://openalex.org/keywords/software-engineering","display_name":"Software engineering","score":0.4726659059524536},{"id":"https://openalex.org/keywords/world-wide-web","display_name":"World Wide Web","score":0.4039555490016937},{"id":"https://openalex.org/keywords/software","display_name":"Software","score":0.16092655062675476},{"id":"https://openalex.org/keywords/programming-language","display_name":"Programming language","score":0.12106168270111084},{"id":"https://openalex.org/keywords/software-development","display_name":"Software development","score":0.1072978675365448},{"id":"https://openalex.org/keywords/software-development-process","display_name":"Software development process","score":0.07967871427536011}],"concepts":[{"id":"https://openalex.org/C56666940","wikidata":"https://www.wikidata.org/wiki/Q788790","display_name":"Documentation","level":2,"score":0.9766584634780884},{"id":"https://openalex.org/C41008148","wikidata":"https://www.wikidata.org/wiki/Q21198","display_name":"Computer science","level":0,"score":0.6919786930084229},{"id":"https://openalex.org/C140396857","wikidata":"https://www.wikidata.org/wiki/Q16934771","display_name":"Internal documentation","level":5,"score":0.6396186351776123},{"id":"https://openalex.org/C81587897","wikidata":"https://www.wikidata.org/wiki/Q181702","display_name":"Software documentation","level":5,"score":0.5871769785881042},{"id":"https://openalex.org/C25688753","wikidata":"https://www.wikidata.org/wiki/Q1413406","display_name":"Technical documentation","level":3,"score":0.5520784854888916},{"id":"https://openalex.org/C2777267654","wikidata":"https://www.wikidata.org/wiki/Q3519023","display_name":"Test (biology)","level":2,"score":0.5456157922744751},{"id":"https://openalex.org/C177264268","wikidata":"https://www.wikidata.org/wiki/Q1514741","display_name":"Set (abstract data type)","level":2,"score":0.5446592569351196},{"id":"https://openalex.org/C120936955","wikidata":"https://www.wikidata.org/wiki/Q2155640","display_name":"Empirical research","level":2,"score":0.48764193058013916},{"id":"https://openalex.org/C115903868","wikidata":"https://www.wikidata.org/wiki/Q80993","display_name":"Software engineering","level":1,"score":0.4726659059524536},{"id":"https://openalex.org/C136764020","wikidata":"https://www.wikidata.org/wiki/Q466","display_name":"World Wide Web","level":1,"score":0.4039555490016937},{"id":"https://openalex.org/C2777904410","wikidata":"https://www.wikidata.org/wiki/Q7397","display_name":"Software","level":2,"score":0.16092655062675476},{"id":"https://openalex.org/C199360897","wikidata":"https://www.wikidata.org/wiki/Q9143","display_name":"Programming language","level":1,"score":0.12106168270111084},{"id":"https://openalex.org/C529173508","wikidata":"https://www.wikidata.org/wiki/Q638608","display_name":"Software development","level":3,"score":0.1072978675365448},{"id":"https://openalex.org/C180152950","wikidata":"https://www.wikidata.org/wiki/Q2904257","display_name":"Software development process","level":4,"score":0.07967871427536011},{"id":"https://openalex.org/C111472728","wikidata":"https://www.wikidata.org/wiki/Q9471","display_name":"Epistemology","level":1,"score":0.0},{"id":"https://openalex.org/C86803240","wikidata":"https://www.wikidata.org/wiki/Q420","display_name":"Biology","level":0,"score":0.0},{"id":"https://openalex.org/C138885662","wikidata":"https://www.wikidata.org/wiki/Q5891","display_name":"Philosophy","level":0,"score":0.0},{"id":"https://openalex.org/C186846655","wikidata":"https://www.wikidata.org/wiki/Q3398377","display_name":"Software construction","level":4,"score":0.0},{"id":"https://openalex.org/C151730666","wikidata":"https://www.wikidata.org/wiki/Q7205","display_name":"Paleontology","level":1,"score":0.0}],"mesh":[],"locations_count":1,"locations":[{"id":"doi:10.1145/3380851.3416759","is_oa":true,"landing_page_url":"https://doi.org/10.1145/3380851.3416759","pdf_url":"https://dl.acm.org/doi/pdf/10.1145/3380851.3416759","source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"Proceedings of the 38th ACM International Conference on Design of Communication","raw_type":"proceedings-article"}],"best_oa_location":{"id":"doi:10.1145/3380851.3416759","is_oa":true,"landing_page_url":"https://doi.org/10.1145/3380851.3416759","pdf_url":"https://dl.acm.org/doi/pdf/10.1145/3380851.3416759","source":null,"license":null,"license_id":null,"version":"publishedVersion","is_accepted":true,"is_published":true,"raw_source_name":"Proceedings of the 38th ACM International Conference on Design of Communication","raw_type":"proceedings-article"},"sustainable_development_goals":[],"awards":[{"id":"https://openalex.org/G1731915148","display_name":null,"funder_award_id":"FHprofUnt","funder_id":"https://openalex.org/F4320321114","funder_display_name":"Bundesministerium f\u00fcr Bildung und Forschung"},{"id":"https://openalex.org/G352791218","display_name":null,"funder_award_id":"(BMBF)","funder_id":"https://openalex.org/F4320321114","funder_display_name":"Bundesministerium f\u00fcr Bildung und Forschung"}],"funders":[{"id":"https://openalex.org/F4320321114","display_name":"Bundesministerium f\u00fcr Bildung und Forschung","ror":"https://ror.org/04pz7b180"}],"has_content":{"grobid_xml":true,"pdf":true},"content_urls":{"pdf":"https://content.openalex.org/works/W3089582840.pdf","grobid_xml":"https://content.openalex.org/works/W3089582840.grobid-xml"},"referenced_works_count":34,"referenced_works":["https://openalex.org/W1592921186","https://openalex.org/W1602028541","https://openalex.org/W1884204318","https://openalex.org/W1951724000","https://openalex.org/W1981075560","https://openalex.org/W1986136221","https://openalex.org/W1989526951","https://openalex.org/W1990693033","https://openalex.org/W1991613282","https://openalex.org/W1992154356","https://openalex.org/W2008107570","https://openalex.org/W2016650943","https://openalex.org/W2035042871","https://openalex.org/W2068655728","https://openalex.org/W2084429940","https://openalex.org/W2104561662","https://openalex.org/W2114315419","https://openalex.org/W2123565526","https://openalex.org/W2125001590","https://openalex.org/W2129191002","https://openalex.org/W2143151143","https://openalex.org/W2161847731","https://openalex.org/W2166271660","https://openalex.org/W2395092677","https://openalex.org/W2582743722","https://openalex.org/W2603768880","https://openalex.org/W2739693438","https://openalex.org/W2897813007","https://openalex.org/W2951474986","https://openalex.org/W2970481120","https://openalex.org/W3012380719","https://openalex.org/W3088037602","https://openalex.org/W3101091275","https://openalex.org/W4288333800"],"related_works":["https://openalex.org/W31410542","https://openalex.org/W2955439455","https://openalex.org/W2033083755","https://openalex.org/W2465647915","https://openalex.org/W1993376192","https://openalex.org/W4231015519","https://openalex.org/W1780032534","https://openalex.org/W2058548397","https://openalex.org/W2077646572","https://openalex.org/W2061757721"],"abstract_inverted_index":{"The":[0],"growing":[1],"importance":[2],"of":[3,23,40,60,68,71,77],"APIs":[4],"creates":[5],"a":[6,75],"need":[7],"to":[8,52,91],"support":[9,153],"developers":[10,24,72,116],"with":[11,80,118,156],"effective":[12],"documentation.":[13,31,54,112],"Prior":[14],"research":[15],"has":[16],"generated":[17],"important":[18],"findings":[19],"regarding":[20],"information":[21],"needs":[22],"and":[25,128,133,151],"expectations":[26],"they":[27,83],"form":[28],"towards":[29],"API":[30,82,99],"Several":[32],"guidelines":[33,49,97,141],"have":[34,147],"been":[35],"proposed":[36,102],"on":[37,74,124],"the":[38,58,66,104,107,125,135,140,148],"basis":[39],"these":[41],"findings,":[42],"but":[43],"evidence":[44],"is":[45],"lacking":[46],"whether":[47],"such":[48],"actually":[50],"lead":[51],"better":[53],"This":[55],"paper":[56],"contributes":[57],"results":[59],"an":[61,81,157],"empirical":[62],"test":[63,126],"that":[64,115,139],"compared":[65],"performance":[67],"two":[69],"groups":[70],"working":[73,117],"set":[76],"pre-defined":[78],"tasks":[79,127],"were":[84,129],"unfamiliar":[85],"with.":[86],"One":[87],"group":[88,109],"had":[89],"access":[90],"documentation":[92,100,120],"which":[93],"was":[94],"optimized":[95,119],"following":[96],"for":[98],"design":[101],"in":[103,131,143],"literature":[105],"whereas":[106],"other":[108],"used":[110,142],"non-optimized":[111],"Results":[113],"show":[114],"made":[121],"fewer":[122],"errors":[123],"faster":[130],"planning":[132],"executing":[134],"tasks.":[136],"We":[137],"conclude":[138],"our":[144],"study":[145],"do":[146],"intended":[149],"effect":[150],"effectively":[152],"initial":[154],"interactions":[155],"API.":[158]},"counts_by_year":[{"year":2025,"cited_by_count":1},{"year":2024,"cited_by_count":1},{"year":2023,"cited_by_count":3},{"year":2022,"cited_by_count":2},{"year":2021,"cited_by_count":1}],"updated_date":"2026-03-11T14:59:36.786465","created_date":"2025-10-10T00:00:00"}