Extracting Development Tasks to Navigate Software Documentation

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.

1 Introduction and Motivation

The knowledge needed by software developers is captured in many forms of documentation, typically written by different individuals [53]. Despite the best efforts of documentation writers [14], there often remains a mismatch between the needs of documentation consumers and the knowledge provided in developer documentation. This mismatch can be observed whenever developers struggle to find the right information in the right form at the right time [28] , [43].