Measuring API documentation on the web

@inproceedings{Parnin2011MeasuringAD,
  title={Measuring API documentation on the web},
  author={Chris Parnin and Christoph Treude},
  booktitle={Web2SE '11},
  year={2011}
}
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… Expand
Automatic API Usage Scenario Documentation from Technical Q&A Sites
TLDR
Two novel algorithms are presented that can be used to automatically produce API documentation from SO by combining code examples and reviews towards those examples, which shows the distribution of positivity and negativity around the code examples of an API using different metrics. Expand
Blogging developer knowledge: Motivations, challenges, and future directions
TLDR
A research agenda aimed at understanding the motivations and issues of software development blogging is described, which found that developers used blogging for a variety of functions such as documentation, technology discussion, and announcing progress. Expand
Towards Building API Usage Example Metrics
TLDR
The goal of this paper is to develop metrics for empirical measurement of examples and to offer support during the APIs example creation steps, and this paper represents the starting point towards that aim. Expand
Web usage patterns of developers
TLDR
Whether web usage is detriment to a developer's focus on work from a sample over 150 developers is explored, and quantitative findings suggest that web usage does not have a negative impact on adeveloper's focus. Expand
How do open source communities blog?
TLDR
It is found that the blogging peak period is usually after the software is released, and committers are more likely to blog after corrective engineering than after forward engineering and re-engineering activities. Expand
"Should We Move to Stack Overflow?" Measuring the Utility of Social Media for Developer Support
  • Megan Squire
  • Computer Science
  • 2015 IEEE/ACM 37th IEEE International Conference on Software Engineering
  • 2015
TLDR
The analysis shows that for all four software projects in this study, two of the desired quality indicators, developer participation and response time, did show improvements on Stack Overflow as compared to mailing lists and forums. Expand
Crowd Documentation : Exploring the Coverage and the Dynamics of API Discussions on Stack Overflow
Traditionally, many types of software documentation, such as API documentation, require a process where a few people write for many potential users. The resulting documentation, when it exists, isExpand
Automatic Detection of Five API Documentation Smells: Practitioners’ Perspectives
TLDR
A suite of rule-based, deep and shallow machine learning classifiers are developed to automatically detect the smells of API documentation smells, which are similar to code smells or code anti-patterns. Expand
Using Blog Articles in Software Engineering Research: Benefits, Challenges and Case–Survey Method
  • A. Rainer, A. Williams
  • Computer Science
  • 2018 25th Australasian Software Engineering Conference (ASWEC)
  • 2018
TLDR
An automated methodology, based on the case survey, is described, to gather and analyse blog–based evidence to ensure that large volumes of higher–quality blog content can be used effectively in research. Expand
On the Extraction of Cookbooks for APIs from the Crowd Knowledge
TLDR
An automatic approach is presented that organizes the information available on StackOverflow.com in order to build cookbooks (recipe-oriented books) for APIs, which are meant to be used through an exploration process (browsing). Expand
...
1
2
3
4
5
...

References

SHOWING 1-10 OF 24 REFERENCES
How do programmers ask and answer questions on the web?: NIER track
TLDR
Data from Stack Overflow is analyzed to categorize the kinds of questions asked, and to explore which questions are answered well and which ones remain unanswered, indicating that Q&A websites are particularly effective at code reviews and conceptual questions. Expand
A survey of social media use in software systems development
TLDR
The preliminary results of a pilot survey conducted to collect information on social media use in global software systems development show that social media can enable better communication through the software system development process. Expand
Jadeite: improving API documentation using usage information
TLDR
Jadeite's "placeholders" let users add new "pretend" classes or methods that are displayed in the actual API documentation, and can be annotated with the appropriate APIs to use instead. Expand
Assieme: finding and leveraging implicit references in a web search interface for programmers
TLDR
In a study of programmers performing searches related to common programming tasks, it is shown that programmers obtain better solutions, using fewer queries, in the same amount of time spent using a general Web search interface. Expand
What Makes APIs Hard to Learn? Answers from Developers
TLDR
The article focuses on the obstacles to learning an API and concludes that as APIs keep growing larger, developers will need to learn a proportionally smaller fraction of the whole. Expand
Mica: A Web-Search Tool for Finding API Components and Examples
TLDR
A new prototype search tool called Mica is presented that augments standard Web search results to help programmers find the right API classes and methods given a description of the desired functionality, and help programmers finding examples when they already know which methods to use. Expand
Creating and evolving developer documentation: understanding the decisions of open source contributors
TLDR
A qualitative study in which core contributors who wrote developer documentation and developers who read documentation were interviewed, observing how working on the documentation could improve the code quality and how constant interaction with the projects' community positively impacted the documentation. Expand
The role of blogging in generating a software product vision
  • Shelly Park, F. Maurer
  • Computer Science
  • 2009 ICSE Workshop on Cooperative and Human Aspects on Software Engineering
  • 2009
TLDR
This work discusses four types of strategies for expressing one's desire for requirements and analyzes how stories turn into consensus. Expand
Annoki: a MediaWiki-based collaboration platform
TLDR
This paper describes Annoki, a collaboration platform built on top of the popular wiki software MediaWiki that supports collaboration by improving the organization of, managing access to, assisting in the creation of, and graphically displaying information about content stored on the wiki. Expand
What is Web 2.0: Design Patterns and Business Models for the Next Generation of Software
This paper was the first initiative to try to define Web 2.0 and understand its implications for the next generation of software, looking at both design patterns and business modes. Web 2.0 is theExpand
...
1
2
3
...