Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
DEFICIENT DOCUMENTATION DETECTIONA Methodology to Locate Deficient ProjectDocumentation using Topic AnalysisJoshua Charles...
MOTIVATIONDevelopersOfficialCrowd-sourcedMSR 2013 2ProjectDocumentationQ&A Website
RESEARCH QUESTION• Answer the question “Can we identify deficientareas of project documentation by relating it toStack Ove...
METHODOLOGY4StackOverflowQuestionsDataExtractionProjectDocumentationMSR 2013Two-phase Processing• Data extraction• Topic a...
DEFICIENT TOPICS FOUND5MSR 2013
PHP EXAMPLE6• Deficient documentation exists• Stack Overflow question #7321289:• “How want to apply a vignette effect to a...
PYTHON EXAMPLE7• Deficient documentation exists• Stack Overflow question #5893163:• “What is the meaning of _ after for in...
OUT-OF-SCOPE DOCUMENTATION• Questions that related to multiple projects• For example, questions about:• Clear indications ...
CONCLUSION• Developed a method for locating deficientdocumented aspects in project documentation;• Successfully located de...
Upcoming SlideShare
Loading in …5
×

Deficient Documentation Detection: A Methodology to Locate Deficient Project Documentation using Topic Analysis

854 views

Published on

Challenge report presentation at MSR 2013.

  • Be the first to comment

  • Be the first to like this

Deficient Documentation Detection: A Methodology to Locate Deficient Project Documentation using Topic Analysis

  1. 1. DEFICIENT DOCUMENTATION DETECTIONA Methodology to Locate Deficient ProjectDocumentation using Topic AnalysisJoshua Charles Campbell Department of Computing ScienceChenlei Zhang Department of Computing ScienceZhen Xu Department of Electrical and Computer EngineeringAbram Hindle Department of Computing ScienceJames Miller Department of Electrical and Computer EngineeringThe 10th Working Conference on Mining Software Repositories
  2. 2. MOTIVATIONDevelopersOfficialCrowd-sourcedMSR 2013 2ProjectDocumentationQ&A Website
  3. 3. RESEARCH QUESTION• Answer the question “Can we identify deficientareas of project documentation by relating it toStack Overflow questions?”• Provide a method to relate crowd-sourcedquestions and project documentation.3MSR 2013
  4. 4. METHODOLOGY4StackOverflowQuestionsDataExtractionProjectDocumentationMSR 2013Two-phase Processing• Data extraction• Topic analysisLDARanked DeficientTopicsTopicAnalysisStack OverflowQuestion/TopicMatrixProjectDocumentation/TopicMatrixMaxSubtract
  5. 5. DEFICIENT TOPICS FOUND5MSR 2013
  6. 6. PHP EXAMPLE6• Deficient documentation exists• Stack Overflow question #7321289:• “How want to apply a vignette effect to an image using PHP withImageMagik. I found this function but I’m not sure how to use it.”• PHP documentation:• Imagick::vignetteImage• http://www.php.net/manual/en/imagick.vignetteimage.phpMSR 2013
  7. 7. PYTHON EXAMPLE7• Deficient documentation exists• Stack Overflow question #5893163:• “What is the meaning of _ after for in this code?”MSR 2013
  8. 8. OUT-OF-SCOPE DOCUMENTATION• Questions that related to multiple projects• For example, questions about:• Clear indications and links should be includedwhen a user should reference external projectdocumentation8HTMLMSR 2013MySQL
  9. 9. CONCLUSION• Developed a method for locating deficientdocumented aspects in project documentation;• Successfully located deficient projectdocumentation using Stack Overflow questions.9MSR 2013

×