Deficient documentation detection: a methodology to locate deficient project documentation using topic analysis
Loading...
Date
Citation for Previous Publication
Link to Related Item
Abstract
Description
A project's documentation is the primary source of information for developers using that project. With hundreds of thousands of programming-related questions posted on programming Q&A websites, such as Stack Overflow, we question whether the developer-written documentation provides enough guidance for programmers. In this study, we wanted to know if there are any topics which are inadequately covered by the project documentation. We combined questions from Stack Overflow and documentation from the PHP and Python projects. Then, we applied topic analysis to this data using latent Dirichlet allocation (LDA), and found topics in Stack Overflow that did not overlap the project documentation. We successfully located topics that had deficient project documentation. We also found topics in need of tutorial documentation that were outside of the scope of the PHP or Python projects, such as MySQL and HTML.
Item Type
http://purl.org/coar/resource_type/R60J-J5BD
Alternative
Other License Text / Link
Subject/Keywords
Language
en