Extracting Development Tasks to Navigate Software Documentation
- 31 December 2014
- journal article
- Published by Institute of Electrical and Electronics Engineers (IEEE) in IEEE Transactions on Software Engineering
- Vol. 41 (6) , 565-581
Abstract
Knowledge management plays a central role in many software development organizations. While much of the important technical knowledge can be captured in documentation, there often exists a gap between the information needs of software developers and the documentation structure. To help developers navigate documentation, we developed a technique for automatically extracting tasks from software documentation by conceptualizing tasks as specific programming actions that have been described in the documentation. More than 70 percent of the tasks we extracted from the documentation of two projects were judged meaningful by at least one of two developers. We present TaskNavigator, a user interface for search queries that suggests tasks extracted with our technique in an auto-complete list along with concepts, code elements, and section headers. We conducted a field study in which six professional developers used TaskNavigator for two weeks as part of their ongoing work. We found search results identified through extracted tasks to be more helpful to developers than those found through concepts, code elements, and section headers. The results indicate that task descriptions can be effectively extracted from software documentation, and that they help bridge the gap between documentation structure and the information needs of software developers.Keywords
Funding Information
- NSERC
This publication has 43 references indexed in Scilit:
- The Stanford CoreNLP Natural Language Processing Toolkit2014
- Automatic query reformulations for text retrieval in software engineering2013
- Mining source code descriptions from developer communications2012
- Natural Language Parsing of Program Element Names for Concept Extraction2010
- Partial Domain Comprehension in Software Evolution and Maintenance2008
- Using task context to improve programmer productivity2006
- An information retrieval approach to concept location in source code2005
- Feature identification: a novel approach and a case study2005
- How software engineers use documentation: the state of the practiceIEEE Software, 2003
- X. On the criterion that a given system of deviations from the probable in the case of a correlated system of variables is such that it can be reasonably supposed to have arisen from random samplingJournal of Computers in Education, 1900