{"status":"ok","message-type":"work","message-version":"1.0.0","message":{"indexed":{"date-parts":[[2026,10,18]],"date-time":"2026-10-18T10:22:47Z","timestamp":1792318967290,"version":"4.4.0"},"reference-count":40,"publisher":"Springer Science and Business Media LLC","issue":"6","license":[{"start":{"date-parts":[[2011,12,3]],"date-time":"2011-12-03T00:00:00Z","timestamp":1322870400000},"content-version":"tdm","delay-in-days":0,"URL":"http:\/\/www.springer.com\/tdm"}],"content-domain":{"domain":[],"crossmark-restriction":false},"short-container-title":["Empir Software Eng"],"published-print":{"date-parts":[[2012,12]]},"DOI":"10.1007\/s10664-011-9186-4","type":"journal-article","created":{"date-parts":[[2011,12,3]],"date-time":"2011-12-03T10:54:14Z","timestamp":1322909654000},"page":"703-737","source":"Crossref","is-referenced-by-count":69,"title":["What should developers be aware of? An empirical study on the directives of API documentation"],"prefix":"10.1007","volume":"17","author":[{"given":"Martin","family":"Monperrus","sequence":"first","affiliation":[],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Michael","family":"Eichberg","sequence":"additional","affiliation":[],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Elif","family":"Tekes","sequence":"additional","affiliation":[],"role":[{"vocabulary":"crossref","role":"author"}]},{"given":"Mira","family":"Mezini","sequence":"additional","affiliation":[],"role":[{"vocabulary":"crossref","role":"author"}]}],"member":"297","published-online":{"date-parts":[[2011,12,3]]},"reference":[{"key":"9186_CR1","unstructured":"Alexander C, Ishikawa S, Silverstein M (1977) A pattern language: towns, buildings, construction. Oxford University Press"},{"key":"9186_CR2","doi-asserted-by":"crossref","first-page":"48","DOI":"10.1109\/MC.2003.1244535","volume":"36","author":"K Arnout","year":"2003","unstructured":"Arnout K, Meyer B (2003) Uncovering hidden contracts: the .net example. Comput 36:48\u201355","journal-title":"Comput"},{"key":"9186_CR3","doi-asserted-by":"crossref","unstructured":"Beckman NE, Kim D, Aldrich J (2011) An empirical study of object protocols in the wild. In: Proceedings of the European conference on object-oriented programming. Springer.","DOI":"10.1007\/978-3-642-22655-7_2"},{"key":"9186_CR4","first-page":"195","volume-title":"Proceedings of the 23rd European conference on object-oriented programming, Genoa","author":"K Bierhoff","year":"2009","unstructured":"Bierhoff K, Beckman NE, Aldrich J (2009) Practical api protocol checking with access permissions. In: Proceedings of the 23rd European conference on object-oriented programming, Genoa. Springer, Berlin, Heidelberg, pp 195\u2013219"},{"key":"9186_CR5","unstructured":"Bloch J (2008) Effective java, 2nd edn. Addisson-Wesley"},{"key":"9186_CR6","unstructured":"Bokowski B (2008) Java API design. In: Tutorial at the EclipseCon conference"},{"key":"9186_CR7","unstructured":"Bokowski B, Arthorne J, des Rivi\u00e8res J (2006) Designing eclipse APIs. In: Tutorial at the EclipseCon conference"},{"key":"9186_CR8","doi-asserted-by":"crossref","unstructured":"Bradner S (1997) Key words for use in rfcs to indicate requirement levels. Technical report, IETF","DOI":"10.17487\/rfc2119"},{"key":"9186_CR9","doi-asserted-by":"crossref","unstructured":"Brooks F (1995) The mythical man-month: essays on software engineering. Addison-Wesley","DOI":"10.1109\/MS.1995.10042"},{"key":"9186_CR10","doi-asserted-by":"crossref","unstructured":"Bruch M, Mezini M, Monperrus M (2010) Mining subclassing directives to improve framework reuse. In: Proceedings of the 7th IEEE working conference on mining software repositories. IEEE","DOI":"10.1109\/MSR.2010.5463347"},{"issue":"5","key":"9186_CR11","first-page":"1","volume":"29","author":"S Clarke","year":"2004","unstructured":"Clarke S (2004) Measuring API usability. Dr Dobb\u2019s J 29(5):1\u20135","journal-title":"Dr Dobb\u2019s J"},{"key":"9186_CR12","unstructured":"Cockburn A (2000) Writing effective use cases, 1st edn. Addison-Wesley Longman Publishing Co, Inc"},{"key":"9186_CR13","unstructured":"Dekel U (2009) Increasing awareness of delocalized information to facilitate API usage. PhD thesis, Carnegie Mellon University"},{"key":"9186_CR14","doi-asserted-by":"crossref","unstructured":"Dekel U, Herbsleb JD (2009) Improving API documentation usability with knowledge pushing. In: Proceedings of the 31st international conference on software engineering. IEEE Computer Society, pp 320\u2013330","DOI":"10.1109\/ICSE.2009.5070532"},{"key":"9186_CR15","doi-asserted-by":"crossref","unstructured":"Easterbrook S, Singer J, Storey M-A, Damian D (2007) Selecting empirical methods for software engineering research","DOI":"10.1007\/978-1-84800-044-5_11"},{"key":"9186_CR16","doi-asserted-by":"crossref","unstructured":"Ellis B, Stylos J, Myers B (2007) The factory pattern in api design: a usability evaluation. In: Proceedings of the 29th International Conference on Software Engineering, ICSE \u201907. IEEE Computer Society, pp 302\u2013312","DOI":"10.1109\/ICSE.2007.85"},{"key":"9186_CR17","unstructured":"Gamma E, Helm R, Johnson RE, Vlissides J (1995) Design patterns: elements of reusable object-oriented software. Addison-Wesley"},{"key":"9186_CR18","doi-asserted-by":"crossref","first-page":"13","DOI":"10.1145\/1108792.1108798","volume-title":"Proceedings of the 6th ACM SIGPLAN-SIGSOFT workshop on program analysis for software tools and engineering, PASTE \u201905","author":"D Hovemeyer","year":"2005","unstructured":"Hovemeyer D, Spacco J, Pugh W (2005) Evaluating and tuning a static analysis to find null pointer bugs. In: Proceedings of the 6th ACM SIGPLAN-SIGSOFT workshop on program analysis for software tools and engineering, PASTE \u201905. ACM, New York, NY, USA, pp 13\u201319"},{"key":"9186_CR19","unstructured":"Jiang ZM, Hassan AE (2006) Examining the evolution of code comments in postgresql. In: Proceedings of the 2006 international workshop on mining software repositories. ACM, pp 179\u2013180"},{"key":"9186_CR20","doi-asserted-by":"crossref","unstructured":"Kramer D (1999) API documentation from source code comments: a case study of javadoc. In: Proceedings of the 17th international conference on computer documentation. ACM, pp 147\u2013153","DOI":"10.1145\/318372.318577"},{"key":"9186_CR21","unstructured":"Monperrus M, Eichberg M, Tekes E, Mezini M (2011) Companion web page for \u201cWhat should developers be aware of? An empirical study on the directives of API documentation\u201d. http:\/\/www.monperrus.net\/martin\/api-directives . Last accessed: 12 Oct 2011"},{"key":"9186_CR22","unstructured":"Nanda MG, Sinha S (2009) Accurate interprocedural null-dereference analysis for java. In: Proceedings of the 31st international conference on software engineering. IEEE Computer Society, pp 133\u2013143"},{"key":"9186_CR23","doi-asserted-by":"crossref","unstructured":"Padioleau Y, Tan L, Zhou Y (2009) Listening to programmers? Taxonomies and characteristics of comments in operating system code. In: Proceedings of the 31st international conference on software engineering. IEEE, pp 331\u2013341","DOI":"10.1109\/ICSE.2009.5070533"},{"key":"9186_CR24","doi-asserted-by":"crossref","unstructured":"Parnin C, Treude C (2011) Measuring API documentation on the Web. In: Proceeding of the 2nd international workshop on Web 2.0 for software engineering, Web2SE \u201911. ACM, pp 25\u201330","DOI":"10.1145\/1984701.1984706"},{"issue":"6","key":"9186_CR25","doi-asserted-by":"crossref","first-page":"27","DOI":"10.1109\/MS.2009.193","volume":"26","author":"MP Robillard","year":"2009","unstructured":"Robillard MP (2009) What makes APIs hard to learn? Answers from developers. IEEE Softw 26(6):27\u201334","journal-title":"IEEE Softw"},{"key":"9186_CR26","doi-asserted-by":"crossref","unstructured":"Shi L, Zhong H, Xie T, Li M (2011) An empirical study on evolution of api documentation. In: Proceedings of the 14th international conference on Fundamental Approaches to Software Engineering, FASE\u201911\/ETAPS\u201911. Springer, pp 416\u2013431","DOI":"10.1007\/978-3-642-19811-3_29"},{"key":"9186_CR27","doi-asserted-by":"crossref","unstructured":"Singh R, Mangat NS (1996) Elements of survey sampling. Springer","DOI":"10.1007\/978-94-017-1404-4"},{"key":"9186_CR28","unstructured":"Smith KA, Kramer D (2003) Requirements for writing java API specifications. Technical report, Sun"},{"key":"9186_CR29","doi-asserted-by":"crossref","unstructured":"Storey MA, Ryall J, Bull RI, Myers D, Singer J (2008) TODO or to bug. In: Proceedings of the ACM\/IEEE 30th international conference on software engineering. IEEE, pp 251\u2013260","DOI":"10.1145\/1368088.1368123"},{"key":"9186_CR30","unstructured":"Stylos J (2009) Making APIs more usable with improved API designs, documentation and tools. PhD thesis, Carnegie Mellon University"},{"key":"9186_CR31","doi-asserted-by":"crossref","first-page":"105","DOI":"10.1145\/1453101.1453117","volume-title":"Proceedings of the 16th ACM SIGSOFT international symposium on foundations of software engineering, SIGSOFT \u201908\/FSE-16","author":"J Stylos","year":"2008","unstructured":"Stylos J, Myers BA (2008) The implications of method placement on API learnability. In: Proceedings of the 16th ACM SIGSOFT international symposium on foundations of software engineering, SIGSOFT \u201908\/FSE-16. ACM, New York, NY, USA, pp 105\u2013112"},{"key":"9186_CR32","doi-asserted-by":"crossref","unstructured":"Stylos J, Graf B, Busse DK, Ziegler C, Ehret R, Karstens J (2008) A case study of api redesign for improved usability. In: IEEE symposium on visual languages and human-centric computing, pp 189\u2013192","DOI":"10.1109\/VLHCC.2008.4639083"},{"key":"9186_CR33","doi-asserted-by":"crossref","unstructured":"Stylos J, Faulring A, Yang Z, Myers BA (2009a) Improving API documentation using API usage information. In: Proceedings of the IEEE symposium on Visual Languages and Human-Centric Computing (VL\/HCC\u201909)","DOI":"10.1109\/VLHCC.2009.5295283"},{"key":"9186_CR34","doi-asserted-by":"crossref","unstructured":"Stylos J, Myers BA, Yang Z (2009b) Jadeite: improving API documentation using usage information. In: Proceedings of the 27th international conference on human factors in computing systems. ACM, pp 4429\u20134434","DOI":"10.1145\/1520340.1520678"},{"key":"9186_CR35","doi-asserted-by":"crossref","unstructured":"Tan L, Yuan D, Krishna G, Zhou Y (2007) icomment: bugs or bad comments. In: Proceedings of the symposium on operating systems principles","DOI":"10.1145\/1323293.1294276"},{"key":"9186_CR36","doi-asserted-by":"crossref","unstructured":"Thummalapenta S, Xie T (2008) Spotweb: detecting framework hotspots and coldspots via mining open source code on the Web. In: Proceedings of the international conference on automated software engineering, pp 327\u2013336","DOI":"10.1109\/ASE.2008.43"},{"key":"9186_CR37","unstructured":"Tulach J (2008) Practical API design: confessions of a java framework architect. Apress"},{"key":"9186_CR38","doi-asserted-by":"crossref","unstructured":"Watson RB (2009) Improving software API usability through text analysis: a case study. In: Proceedings of the professional communication conference, pp 1\u20137","DOI":"10.1109\/IPCC.2009.5208679"},{"key":"9186_CR39","doi-asserted-by":"crossref","unstructured":"Ying ATT, Wright JL, Abrams S (2005) Source code that talks: an exploration of Eclipse task comments and their implication to repository mining. In: Proceedings of mining software repositories. ACM, pp 1\u20135","DOI":"10.1145\/1083142.1083152"},{"key":"9186_CR40","doi-asserted-by":"crossref","unstructured":"Zhong H, Zhang L, Xie T, Mei H (2009) Inferring resource specifications from natural language API documentation. In: Proceedings of the international conference on automated software engineering. IEEE Computer Society, pp 307\u2013318","DOI":"10.1109\/ASE.2009.94"}],"container-title":["Empirical Software Engineering"],"original-title":[],"language":"en","link":[{"URL":"http:\/\/link.springer.com\/content\/pdf\/10.1007\/s10664-011-9186-4.pdf","content-type":"application\/pdf","content-version":"vor","intended-application":"text-mining"},{"URL":"http:\/\/link.springer.com\/article\/10.1007\/s10664-011-9186-4\/fulltext.html","content-type":"text\/html","content-version":"vor","intended-application":"text-mining"},{"URL":"http:\/\/link.springer.com\/content\/pdf\/10.1007\/s10664-011-9186-4","content-type":"unspecified","content-version":"vor","intended-application":"similarity-checking"}],"deposited":{"date-parts":[[2023,6,11]],"date-time":"2023-06-11T11:29:15Z","timestamp":1686482955000},"score":1,"resource":{"primary":{"URL":"http:\/\/link.springer.com\/10.1007\/s10664-011-9186-4"}},"subtitle":[],"short-title":[],"issued":{"date-parts":[[2011,12,3]]},"references-count":40,"journal-issue":{"issue":"6","published-print":{"date-parts":[[2012,12]]}},"alternative-id":["9186"],"URL":"https:\/\/doi.org\/10.1007\/s10664-011-9186-4","relation":{},"ISSN":["1382-3256","1573-7616"],"issn-type":[{"value":"1382-3256","type":"print"},{"value":"1573-7616","type":"electronic"}],"subject":[],"published":{"date-parts":[[2011,12,3]]}}}