My current list of API documentation-related articles listed with the newest article first.
The last line of each entry describes the:
- Type of publication
- Type of article
- Type of API
- Authors’ affiliations
Last update: 10 Sep 2018
|
5 Things Learned Generating API Documentation (2018) Delimarsky, Den CS: blogPost on API Documentation Professional, Editorial, Native API (.NET), Industry author(s) |
|
API Documentation Best Practices (2018) Lakatos, Diana TC: webpage on API Documentation Professional, Tutorial, Not Specific API (Not Specific), Industry author(s) |
|
A-Z of API Documentation (2018) TC: blogPost on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Development as a journey: factors supporting the adoption and use of software frameworks (2018) Myllärniemi, Varvana; Kujala, Sari; Raatikainen, Mikko; Sevo?n, Piia CS: journalArticle on API Design Academic, Survey, Not Specific API (Not Specific), Academic author(s) |
|
How to generate your api documentation with Postman in 20 minutes (2018) Temitope, Olotin TC: blogPost on API Documentation Professional, Tool/Method, Web API (REST), Industry author(s) |
|
Investigating type declaration mismatches in Python (2018) Pascarella, Luca; Ram, Achyudh; Nadeem, Azqa; Bisesser, Dinesh; Knyazev, Norman; Bacchelli, Alberto CS: conferencePaper on API Documentation Academic, Survey, Native API (Python), Academic author(s) |
|
Writing Testable API Documentation Using APIB and Dredd (2018) Szmielew, Piotr CS: webpage on API Documentation Professional, Tool/Method, Web API (REST), Industry author(s) |
|
10 Best Practices for Writing Node.js REST APIs | @RisingStack (2017) Nemeth, Gergely CS: webpage on API Design Professional, Tutorial, Web API (REST), Industry author(s) |
|
API documentation (2017) De, Brajesh CS: bookSection on API Documentation Academic, Tutorial, Web API (REST), Industry author(s) |
|
API Technical Writer – Hire For These 8 Skills Or Else… (2017) Gustafson, Peter TC: webpage on API Documentation Professional, Tutorial, Not Specific API (Not Specific), Industry author(s) |
|
APIBot: Question answering bot for API documentation (2017) Tian, Yuan; Thung, Ferdian; Sharma, Abhishek; Lo, David CS: conferencePaper on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
Application Programming Interface Documentation: What Do Software Developers Want? (2017) Meng, Michael; Steinhardt, Stephanie; Schubert, Andreas TC: journalArticle on API Design Academic, Survey, Not Specific API (Not Specific), Academic author(s) |
|
Automated Generation of REST API Specification from Plain HTML Documentation (2017) Cao, Hanyang; Falleri, Jean-Rémy; Blanc, Xavier CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (REST), Academic author(s) |
|
Automation Is the Key for Agile API Documentation (2017) Riggins, Jennifer CS: blogPost on API Documentation Professional, Editorial, Web API (Not Specific), Industry author(s) |
|
Best Practices in API Documentation (2017) Vasudevan, Keshav CS: webpage on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
Al Omran, Fouad Nasser A; Treude, Christoph CS: conferencePaper on API Documentation Academic, Experiment, Not Specific API (Not Specific), Academic author(s) |
|
Components of Killer API Docs (2017) Flower, Zachary CS: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Design annotations to improve API discoverability (2017) Santos, André L; Myers, Brad A CS: journalArticle on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
Detecting near duplicates in software documentation (2017) Luciv, DV; Koznov, DV; Chernishev, GA; Terekhov, Andrey N CS: journalArticle on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
Documentation Reuse: Hot or Not? An Empirical Study (2017) Oumaziz, Mohamed A; Charpentier, Alan; Falleri, Jean-Rémy; Blanc, Xavier CS: conferencePaper on API Documentation Academic, Survey, Native API (Java), Academic author(s) |
|
Documenting APIs: A guide for technical writers | Document REST APIs (2017) Johnson, Tom TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Duplicate management in software documentation maintenance (2017) Koznov, DV; Luciv, DV; Chernishev, GA CS: conferencePaper on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
Generating method documentation using concrete values from executions (2017) Sulír, Matúš; Porubän, Jaroslav CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Good API Documentation Is Not About Choosing the Right Tool (2017) Locqueville, Maxime TC: blogPost on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
Hierarchical RNN Networks for Structured Semantic Web API Model Learning and Extraction (2017) Liu, Shengpeng; Li, Ying; Sun, Guangyu; Fan, Binbin; Deng, Shuiguang CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (REST), Academic author(s) |
|
Learning Semantic Correspondences in Technical Documentation (2017) Richardson, Kyle; Kuhn, Jonas CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Mining unit test cases to synthesize API usage examples (2017) Ghafari, Mohammad; Rubinov, Konstantin; Pourhashem K, Mohammad Mehdi CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
On-demand developer documentation (2017) Robillard, Martin P; Marcus, Andrian; Treude, Christoph; Bavota, Gabriele; Chaparro, Oscar; Ernst, Neil; Gerosa, Marco Aurélio; Godfrey, Michael; Lanza, Michele; Linares-Vásquez, Mario CS: conferencePaper on API Documentation Academic, Editorial, Not Specific API (Not Specific), Academic author(s) |
|
Preliminary Analysis of REST API Style Guidelines (2017) Murphy, Lauren; Alliyu, Tosin; Macvean, Andrew; Kery, Mary Beth; Myers, Brad A CS: journalArticle on API Design Academic, Survey, Various API (Various), Academic/Industry author(s) |
|
Suggesting API Usage to Novice Programmers with the Example Guru (2017) Ichinco, Michelle; Hnin, Wint Yee; Kelleher, Caitlin L TC: conferencePaper on API Documentation Academic, User Study, Native API (Looking Glass), Academic author(s) |
|
Ten Extras for Great API Documentation (2017) Lakatos, Diana TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
The smartAPI ecosystem for making web APIs FAIR (2017) Dastgheib, Shima; Whetzel, Trish; Zaveri, Amrapali; Afrasiabe, C; Assis, Pedro; Availlach, P; Jagodnik, Kathleen; Korodi, Gabor; Pilarczyk, Marcin; De Pons, Jeff CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (REST), Academic author(s) |
|
The Ten Essentials for Good API Documentation (2017) Lakatos, Diana TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
TMAP: Discovering relevant API methods through text mining of API documentation (2017) Pandita, Rahul; Jetley, Raoul; Sudarsan, Sithu; Menzies, Timothy; Williams, Laurie CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Various), Academic/Industry author(s) |
|
Towards Prioritizing Documentation Effort (2017) McBurney, Paul W; Jiang, Siyuan; Kessentini, Marouane; Kraft, Nicholas A; Armaly, Ameer; Mkaouer, Mohamed W; McMillan, Collin CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic/Industry author(s) |
|
What is API Documentation, and Why It Matters? (2017) Vasudevan, Keshav CS: webpage on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
API Best Practices: Documentation (2016) Lane, Kin TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Augmenting API Documentation with Insights from Stack Overflow (2016) Treude, Christoph; Robillard, Martin P. CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Automated API Documentation with Tutorials Generated From Stack Overflow (2016) Rocha, Adriano M.; Maia, Marcelo A. CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Best Practices for Writing API Docs and Keeping Them Up To Date (2016) TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Five Questions Every Technical Writer Faces with API Documentation (2016) Marshall, Ed TC: webpage on API Documentation Professional, Editorial, Not Specific API (Not Specific), Industry author(s) |
|
How to Write Good API Documentation (2016) MuleSoft CS: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
The Easiest Ways to Generate API Documentation | Nordic APIs | (2016) Wood, Chris CS: webpage on API Documentation Professional, Tutorial, Not Specific API (Not Specific), Industry author(s) |
|
Tips for Documenting REST APIs – DZone Integration (2016) Pollock, John TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
An observational study on API usage constraints and their documentation (2015) Saied, M. A.; Sahraoui, H.; Dufour, B. CS: conferencePaper on API Documentation Academic, Survey, Native API (Java), Academic author(s) |
|
Best practices and UX tips for API documentation (2015) Nagygyörgy, Katalin TC: webpage on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
How API Documentation Fails (2015) Uddin, G.; Robillard, M. P. CS: journalArticle on API Documentation Professional, Survey, Native API (Not Specific), Academic/Industry author(s) |
|
How to Write “Good” API Documentation (2015) Kerby, Natalie TC: webpage on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
Recommending reference API documentation (2015) Robillard, Martin P; Chhetri, Yam B CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Spyrest: Automated restful API documentation using an HTTP proxy server (N) (2015) Sohan, Sheikh Mohammed; Anslow, Craig; Maurer, Frank CS: conferencePaper on API Documentation Academic, Survey, Not Specific API (Not Specific), Academic author(s) |
|
The Best API Documentation (2015) Fults, Brad TC: webpage on API Documentation Professional, Tutorial, Web API (Not Specific), Industry author(s) |
|
The Effect of Visual Design and Information Content on Readers’ Assessments of API Reference Topics (2015) Watson, Robert Bennett TC: thesis on API Documentation Academic, Experiment, Native API (Not Specific), Academic author(s) |
|
API Technical Writing (2014) Sarah Maddox TC: presentation on API Documentation Professional, Tutorial, Not Specific API (Not Specific), Industry author(s) |
|
How do api documentation and static typing affect api usability? (2014) Endrikat, Stefan; Hanenberg, Stefan; Robbes, Romain; Stefik, Andreas CS: conferencePaper on API Documentation Academic, Experiment, Native API (Not Specific), Academic author(s) |
|
Live API documentation (2014) Subramanian, Siddharth; Inozemtseva, Laura; Holmes, Reid CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Who Asked What: Integrating Crowdsourced FAQs into API Documentation (2014) Chen, Cong; Zhang, Kang CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Writing API Documentation with Slate (2014) White, Lukas TC: blogPost on API Documentation Professional, Tool/Method, Web API (REST), Industry author(s) |
|
API Documentation – Why it sucks (2013) Parnin, Chris CS: webpage on API Documentation Professional, Case Study, Native API (Android), Academic author(s) |
|
API documentation and software community values: a survey of open-source API documentation (2013) Watson, Robert; Mark Stamnes, Mark; Jeannot-Schroeder, Jacob; Spyridakis, Jan H TC: conferencePaper on API Documentation Academic, Survey, Not Specific API (Not Specific), Academic author(s) |
|
Detecting API documentation errors (2013) Zhong, Hao; Su, Zhendong CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Generating API-usage Example for Project Developers (2013) Zhu, Zixiao; Zou, Yanzhen; Jin, Yong; Xie, Bing CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
How to become an API technical writer | ffeathers (2013) Maddox, Sarah TC: webpage on API Documentation Professional, Editorial, Not Specific API (Not Specific), Industry author(s) |
|
Patterns of Knowledge in API Reference Documentation (2013) Maalej, W.; Robillard, M.P. CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java, .NET), Academic author(s) |
|
Validation and interactivity of web API documentation (2013) Danielsen, Peter J; Jeffrey, Alan CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (REST), Industry author(s) |
|
Writing API Documentation in an Agile Environment (2013) Fingold, Jonathan TC: webpage on API Documentation Professional, Editorial, Not Specific API (Not Specific), Industry author(s) |
|
Automated information extraction from web APIs documentation (2012) Ly, Papa Alioune; Pedrinaci, Carlos; Domingue, John CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (Not Specific), Academic author(s) |
|
Crowd documentation: Exploring the coverage and the dynamics of API discussions on Stack Overflow (2012) Parnin, Chris; Treude, Christoph; Grammel, Lars; Storey, Margaret-Anne CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Android), Academic author(s) |
|
Designing Great API Docs (2012) Yu, James TC: webpage on API Documentation Professional, Tutorial, Not Specific API (Not Specific), Industry author(s) |
|
Watson, R. TC: conferencePaper on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
Development and application of a heuristic to assess trends in API documentation (2012) Watson, R.B. TC: conferencePaper on API Documentation Academic, Tool/Method, Web API (JavaScript), Academic author(s) |
|
Extracting models from web API documentation (2012) Rodríguez, Rolando; Espinosa, Roberto; Bianchini, Devis; Garrigós, Irene; Mazón, Jose-Norberto; Zubcoff, Jose CS: journalArticle on API Documentation Academic, Tool/Method, Web API (Not Specific), Academic author(s) |
|
Facing up to the Inequality of Crowdsourced API Documentation (2012) Jiau, Hewijin Christine; Yang, Feng-Pu CS: journalArticle on API Documentation Academic, Case Study, Web API (Not Specific), Academic author(s) |
|
How to Write Good Object-oriented API Documentation (2012) Monperrus, Martin CS: webpage on API Documentation Professional, Tutorial, Native API (Java), Academic author(s) |
|
Ros, Irene TC: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
Synthesizing API usage examples (2012) Buse, Raymond PL; Weimer, Westley CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
What makes a good code example?: A study of programming Q&A in StackOverflow (2012) Nasehi, Seyed Mehdi; Sillito, Jonathan; Maurer, Frank; Burns, Chris CS: conferencePaper on API Documentation Academic, Tool/Method, Not Specific API (Not Specific), Academic author(s) |
|
What should developers be aware of? An empirical study on the directives of API documentation (2012) Monperrus, Martin; Eichberg, Michael; Tekes, Elif; Mezini, Mira CS: journalArticle on API Documentation Academic, Case Study, Native API (Java), Academic author(s) |
|
Why We Write API Documentation (2012) Gruenbaum, Peter CS: webpage on API Documentation Professional, Editorial, Not Specific API (Not Specific), Industry author(s) |
|
A field study of API learning obstacles (2011) Robillard, M.P.; DeLine, R. CS: journalArticle on API Design Academic, User Study, Native API (Windows), Academic/Industry author(s) |
|
An empirical study on evolution of API documentation (2011) Shi, Lin; Zhong, Hao; Xie, Tao; Li, Mingshu CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
API design for humans (2011) Lorang, Noah CS: webpage on API Design Professional, Tutorial, Web API (Rest), Industry author(s) |
|
Measuring api documentation on the web (2011) Parnin, Chris; Treude, Christoph CS: conferencePaper on API Documentation Academic, Tool/Method, Web API (Jquery), Academic author(s) |
|
Recommending proper API code examples for documentation purpose (2011) Mar, Lee Wei; Wu, Ye-Chi; Jiau, Hewijin Christine CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Unknown author(s) |
|
The role of conceptual knowledge in API usability (2011) Ko, A.J.; Riche, Y. CS: conferencePaper on API Design Academic, User Study, Native API (Not Specific), Academic/Industry author(s) |
|
Writing helpful API documentation (2011) Mihaly, Ferenc TC: blogPost on API Documentation Professional, Tutorial, Native API (Not Specific), Industry author(s) |
|
CoDocent: Support API usage with code example and API documentation (2010) Wu, Ye-Chi; Mar, Lee Wei; Jiau, Hewijin Christine CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Incorporating Usability into the API Design Process (2010) Watson, Robert TC: bookSection on API Design Academic, Tool/Method, Native API (Not Specific), Industry author(s) |
|
MSDN Magazine: “Hello World!” A Coder’s Guide to Writing API Documentation (2010) Gruenbaum, Peter TC: webpage on API Documentation Professional, Tutorial, Native API (C#), Industry author(s) |
|
Recommending source code examples via api call usages and documentation (2010) McMillan, Collin; Poshyvanyk, Denys; Grechanik, Mark CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic/Industry author(s) |
|
Tool support for crosscutting concerns of API documentation (2010) Horie, Michihiro; Chiba, Shigeru CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Web API Documentation Best Practices (2010) Gruenbaum, Peter CS: webpage on API Documentation Professional, Tutorial, Web API (REST), Industry author(s) |
|
What do you consider good API documentation? (2010) Various CS: webpage on API Documentation Professional, Tutorial, Native API (Not Specific), Industry author(s) |
|
Improving API documentation usability with knowledge pushing (2009) Dekel, Uri; Herbsleb, James D CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Improving software API usability through text analysis: A case study (2009) Watson, Robert B TC: conferencePaper on API Design Academic, Tool/Method, Native API (C#), Industry author(s) |
|
Inferring resource specifications from natural language API documentation (2009) Zhong, Hao; Zhang, Lu; Xie, Tao; Mei, Hong CS: conferencePaper on API Design Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Jadeite: improving API documentation using usage information (2009) Stylos, Jeffrey; Myers, Brad A; Yang, Zizhuang CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
What makes apis hard to learn? answers from developers (2009) Robillard, Martin P CS: journalArticle on API Design Professional, Survey, Native API (Windows), Academic/Industry author(s) |
|
Opportunistic programming: How rapid ideation and prototyping occur in practice (2008) Brandt, Joel; Guo, Philip J; Lewenstein, Joel; Klemmer, Scott R CS: conferencePaper on Developer Study Academic, User Study, Native API (PHP), Academic author(s) |
|
API design matters (2007) Henning, M. CS: journalArticle on API Design Professional, Editorial, Native API (C#), Industry author(s) |
|
How to design a good API and why it matters (2006) Bloch, J. CS: conferencePaper on API Design Academic, Tutorial, Native API (Not Specific), Industry author(s) |
|
Mica: A web-search tool for finding API components and examples (2006) Stylos, J.; Myers, B.A. CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Why Are APIs Difficult to Learn and Use? (2006) Scaffidi, Christopher CS: journalArticle on API Design Professional, Tool/Method, Native API (C/C++), Academic author(s) |
|
Profiling software API usability for consumer electronics (2005) Bore, C; Bore, S CS: conferencePaper on API Design Academic, Tool/Method, Native API (Not Specific), Industry author(s) |
|
Measuring API Usability (2004) Clarke, Steven CS: webpage on API Design Professional, Tool/Method, Native API (C#), Industry author(s) |
|
API documentation with executable examples (2003) Hoffman, Daniel; Strooper, Paul CS: journalArticle on API Documentation Academic, Tool/Method, Native API (Java), Academic author(s) |
|
Documenting C, C++ and Java Software from GUI to API (2003) Darrow, John CS: book on API Documentation Professional, Tutorial, Native API (Not Specific), Academic author(s) |
|
Automatically connecting documentation to code with rose (2002) Pierce, Robert; Tilley, Scott TC: conferencePaper on API Documentation Academic, Tool/Method, Native API (C/C++), Academic/Industry author(s) |
|
Using Javadoc and XML to produce API reference documentation (2002) Leslie, Donald M CS: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Industry author(s) |
|
Creating an SDK: Writing on the edge (2001) Sarr, J.T. TC: journalArticle on API Documentation Professional, Tutorial, Native API (Not Specific), Industry author(s) |
|
API documentation from source code comments: a case study of Javadoc (1999) Kramer, Douglas TC: conferencePaper on API Documentation Academic, Tool/Method, Native API (Java), Unknown author(s) |
|
Building more usable APIs (1998) McLellan, S.G.; Roesler, A.W.; Tempest, J.T.; Spinuzzi, C.I. CS: journalArticle on API Design Professional, Usability test, Native API (C/C++), Academic/Industry author(s) |
|
The design of distributed hyperlinked programming documentation (1996) Friendly, Lisa CS: bookSection on API Documentation Academic, Tool/Method, Native API (Java), Industry author(s) |