Measuring API documentation on the web

• Main Authors: PARNIN, Chris, TREUDE, Christoph
• Format: text
• Language: English
• Published: Institutional Knowledge at Singapore Management University 2011
• Subjects: api documentation; social media; crowd documentation; Software Engineering
• Online Access: https://ink.library.smu.edu.sg/sis_research/8951; https://ink.library.smu.edu.sg/context/sis_research/article/9954/viewcontent/web2se11.pdf
• Institution: Singapore Management University

Software development blogs, developer forums and Q&A websites are changing the way software is documented. With these tools, developers can create and communicate knowledge and experiences without relying on a central authority to provide official documentation. Instead, any content created by a developer is just a web search away. To understand whether documentation via social media can replace or augment more traditional forms of documentation, we study the extent to which the methods of one particular API — jQuery — are documented on the Web. We analyze 1,730 search results and show that software development blogs in particular cover 87.9% of the API methods, mainly featuring tutorials and personal experiences about using the methods. Further, this effort is shared by a large group of developers contributing just a few blog posts. Our findings indicate that social media is more than a niche in software documentation, that it can provide high levels of coverage and that it gives readers a chance to engage with authors.