Grant: Engage Grants Program
McGill University
$25,000.00
Automated generation of cross-references for heterogeneous software documentation
FY 2012-13
Summary
Xprima Technology is an on-line portal supporting the auto resale industry. Its competitiveness relies on a
complex, heterogeneous array of software assets in the form of a custom framework for creating and
maintaining websites. At Xprima Technology, the documentation includes application programming interface
(API) documentation, documentation of different web page templates, style guides, descriptions of common
programming tasks, and various configuration checklists. The main challenge for developers working with this
heterogeneous documentation is the lack of a clear navigation structure, resulting in oversights and
unproductive searching and navigation activities.
We propose to investigate how to enhance the documentation structure through the automated generation of
""see also"" cross-references to related documentation resources. The particular challenge presented by the
software at Xprima Technology is the presence of different kinds of documentation, such as API
documentation and style guides, as well as the lack of an explicit structure. To address this problem, we will
build on our extensive experience in, and research infrastructure for, the recovery of traceability links in formal
and informal software documentation, as well as on our empirical data on the distribution of knowledge in
software documentation.
A challenge with recovering links between software development artifacts is that the notion of ""relatedness""
remains subjective and context-sensitive. The major advantage of conducting this work in collaboration with
Xprima Technology will be to explore the notion of relatedness in a concrete industrial context. This
exploration should lead to the better formulation of documentation organization problems and lead to further
research collaboration with Xprima Technology.
Program
Engage Grants Program
Recipient
Location
Quebec, Canada
Recipient Type
Academia
Type
Grant
Source
NSERC's Awards Data
As published
Application id
445891-2012
Name nom
Robillard, Martin
Department département
Computer Science, School of
Organization id
61
Institution établissement
McGill University
Province en
Québec
Province fr
Québec
Country en
CANADA
Country fr
CANADA
Fiscal year exercice financier
2012
Competition year année de concours
2012
Award amount
25000
Program id
EGP
Program name en
Engage Grants Program
Program name fr
Programme de subventions d'engagement partenariat
Group en
Research partnerships programs
Group fr
Programmes de partenariat
Committee code
1552
Committee name en
Quebec Internal Decision Committee
Committee name fr
Comité de décision interne pour le Québec
Area of application code
900
Area of application group en
Commercial services
Area of application group fr
Services commerciaux
Area of application en
Commercial services
Area of application fr
Services commerciaux
Research subject code
2705
Research subject group en
Information technology
Research subject group fr
Technologie de l'information
Research subject en
Software and development
Research subject fr
Logiciels et développement
Partie
1
Nb partie
1
Application title
Automated generation of cross-references for heterogeneous software documentation
Keyword
NSERC
Application summary
Xprima Technology is an on-line portal supporting the auto resale industry. Its competitiveness relies on a
complex, heterogeneous array of software assets in the form of a custom framework for creating and
maintaining websites. At Xprima Technology, the documentation includes application programming interface
(API) documentation, documentation of different web page templates, style guides, descriptions of common
programming tasks, and various configuration checklists. The main challenge for developers working with this
heterogeneous documentation is the lack of a clear navigation structure, resulting in oversights and
unproductive searching and navigation activities.
We propose to investigate how to enhance the documentation structure through the automated generation of
""see also"" cross-references to related documentation resources. The particular challenge presented by the
software at Xprima Technology is the presence of different kinds of documentation, such as API
documentation and style guides, as well as the lack of an explicit structure. To address this problem, we will
build on our extensive experience in, and research infrastructure for, the recovery of traceability links in formal
and informal software documentation, as well as on our empirical data on the distribution of knowledge in
software documentation.
A challenge with recovering links between software development artifacts is that the notion of ""relatedness""
remains subjective and context-sensitive. The major advantage of conducting this work in collaboration with
Xprima Technology will be to explore the notion of relatedness in a concrete industrial context. This
exploration should lead to the better formulation of documentation organization problems and lead to further
research collaboration with Xprima Technology.