DocumentCode
3406468
Title
Deficient documentation detection a methodology to locate deficient project documentation using topic analysis
Author
Campbell, Joshua-Charles ; Chenlei Zhang ; Zhen Xu ; Hindle, Adrian ; Miller, Jason
Author_Institution
Dept. of Comput. Sci., Univ. of Alberta, Edmonton, AB, Canada
fYear
2013
fDate
18-19 May 2013
Firstpage
57
Lastpage
60
Abstract
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.
Keywords
project management; system documentation; LDA; PHP projects; Python projects; Stack Overflow; deficient project documentation detection; developer-written documentation; latent Dirichlet allocation; programming Q&A websites; topic analysis; Data mining; Documentation; HTML; Internet; Programming; Resource management; Software; LDA; Stack Overflow; documentation; topic analysis;
fLanguage
English
Publisher
ieee
Conference_Titel
Mining Software Repositories (MSR), 2013 10th IEEE Working Conference on
Conference_Location
San Francisco, CA
ISSN
2160-1852
Print_ISBN
978-1-4799-0345-0
Type
conf
DOI
10.1109/MSR.2013.6624005
Filename
6624005
Link To Document