Chris Parnin
Christoph Treude
ABSTRACT
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.
- A. Begel, Y. P. Khoo, and T. Zimmermann. Codebook: discovering and exploiting relationships in software repositories. In Proceedings of the 32nd ACM/IEEE International Conference on Software Engineering - Volume 1, ICSE '10, pages 125--134, New York, NY, USA, 2010. ACM. Google Scholar
Digital Library
- S. Black, R. Harrison, and M. Baldwin. A survey of social media use in software systems development. In Web2SE '10: Proceedings of the 1st Workshop on Web 2.0 for Software Engineering, pages 1--5, New York, NY, USA, 2010. ACM. Google ScholarDigital Library
- B. Dagenais and M. P. Robillard. Creating and evolving developer documentation: Understanding the decisions of open source contributors. In Proceedings of the 18th ACM SIGSOFT International Symposium on the Foundations of Software Engineering, pages 127--136, November 2010. Google ScholarDigital Library
- L. Efimova and J. Grudin. Crossing boundaries: A case study of employee blogging. In HICSS '07: Proceedings of the 40th Annual Hawaii International Conference on System Sciences, page 86, Washington, DC, USA, 2007. IEEE Computer Society. Google ScholarDigital Library
- R. Hoffmann, J. Fogarty, and D. S. Weld. Assieme: finding and leveraging implicit references in a web search interface for programmers. In Proceedings of the 20th annual ACM symposium on User interface software and technology, UIST '07, pages 13--22, New York, NY, USA, 2007. ACM. Google ScholarDigital Library
- R. Holmes and R. J. Walker. A newbie's guide to eclipse apis. In Proceedings of the 2008 international working conference on Mining software repositories, MSR '08, pages 149--152. ACM, 2008. Google ScholarDigital Library
- J. Huh, L. Jones, T. Erickson, W. A. Kellogg, R. K. E. Bellamy, and J. C. Thomas. Blogcentral: the role of internal blogs at work. In CHI '07: CHI '07 extended abstracts on Human factors in computing systems, pages 2447--2452, New York, NY, USA, 2007. ACM. Google ScholarDigital Library
- M. Kajko-Mattsson. A survey of documentation practice within corrective maintenance. Empirical Softw. Engg., 10(1):31--55, 2005. Google ScholarDigital Library
- T. C. Lethbridge, J. Singer, and A. Forward. How software engineers use documentation: The state of the practice. IEEE Software, 20:35--39, 2003. Google ScholarDigital Library
- L. Mamykina, B. Hartmann, B. Manoim, and M. Mittal. Design lessons from the fastest q&a site in the west. In CHI '11: Proceeding of the 29th conf. on Human factors in computing systems, 2011. Google ScholarDigital Library
- D. Mandelin, L. Xu, R. Bodík, and D. Kimelman. Jungloid mining: helping to navigate the api jungle. In Proceedings of the 2005 ACM SIGPLAN conference on Programming language design and implementation, PLDI '05, pages 48--61. ACM, 2005. Google ScholarDigital Library
- D. R. Millen, J. Feinberg, and B. Kerr. Dogear: Social bookmarking in the enterprise. In Proceedings of the SIGCHI conference on Human Factors in computing systems, CHI '06, pages 111--120, New York, NY, USA, 2006. ACM. Google ScholarDigital Library
- S. Murugesan. Understanding web 2.0. IT Professional, 9:34--41, July 2007. Google ScholarDigital Library
- T. O'Reilly. What is Web 2.0: Design patterns and business models for the next generation of software, 2005. http://oreilly.com/web2/archive/what-is-web-20.html.Google Scholar
- S. Park and F. Maurer. The role of blogging in generating a software product vision. In CHASE '09: Proceedings of the 2009 ICSE Workshop on Cooperative and Human Aspects on Software Engineering, pages 74--77, Washington, DC, USA, 2009. IEEE Computer Society. Google ScholarDigital Library
- M. P. Robillard. What makes apis hard to learn? answers from developers. IEEE Softw., 26:27--34, November 2009. Google ScholarDigital Library
- N. Seyff, F. Graf, and N. Maiden. End-user requirements blogging with irequire. In ICSE '10: Proceedings of the 32nd ACM/IEEE International Conference on Software Engineering, pages 285--288, New York, NY, USA, 2010. ACM. Google ScholarDigital Library
- J. Stylos. Msdn programming help resources survey. Personal Communication.Google Scholar
- J. Stylos and B. A. Myers. Mica: A web-search tool for finding api components and examples. In Proceedings of the Visual Languages and Human-Centric Computing, pages 195--202, Washington, DC, USA, 2006. IEEE Computer Society. Google ScholarDigital Library
- J. Stylos, B. A. Myers, and Z. Yang. Jadeite: improving api documentation using usage information. In Proceedings of the 27th international conference extended abstracts on Human factors in computing systems, CHI '09, pages 4429--4434, New York, NY, USA, 2009. ACM. Google ScholarDigital Library
- B. Tansey and E. Stroulia. Annoki: a mediawiki-based collaboration platform. In Proceedings of the 1st Workshop on Web 2.0 for Software Engineering, Web2SE '10, pages 31--36, New York, NY, USA, 2010. ACM. Google ScholarDigital Library
- C. Treude, O. Barzilay, and M.-A. Storey. How do programmers ask and answer questions on the web? (nier track). In Proceedings of the 33rd ACM/IEEE International Conference on Software Engineering - Volume 2, 2011. Google ScholarDigital Library
Index Terms
- Measuring API documentation on the web
Recommendations
Patterns of Knowledge in API Reference Documentation
Reading reference documentation is an important part of programming with application programming interfaces (APIs). Reference documentation complements the API by providing information not obvious from the API syntax. To improve the quality of reference ...
Rap4DQ: Learning to recommend relevant API documentation for developer questions
AbstractDevelopers often face difficulties in using different API methods during the software development process. Answering API related questions on API Q&A forums often costs API development teams a lot of time. To help save time for API development ...
Measuring influence on Twitter
i-KNOW '11: Proceedings of the 11th International Conference on Knowledge Management and Knowledge TechnologiesThere are currently over 175 million Twitter accounts worldwide, making Twitter one of the most popular and most observed Social Media platform. But Twitter is not so much a social network where the exchange of personal information is facilitated -- in ...
Comments