Grant: Discovery Grants Program - Individual
McGill University
$59,000.00
Generating Layered Software Documentation with Guided Synthesis
FY 2024-25
Summary
Software documentation provides crucial information that cannot be practically encoded in the software components. Most documentation for software developers is available in a format akin to the traditional manual, where users must find a manually-created document and peruse its code examples and their explanations. A number of challenges have emerged to threaten the viability of the traditional approach to software documentation: 1) the number of software components that must be documented is growing fast; 2) the release cycle of software technology has become very short; 3) a more diverse population is now using software technologies; 4) reusable technologies are increasingly specialized, with corresponding documentation requirements.
To face these challenges, we will investigate a new approach to software documentation we call Layered Thematic Documentation. Our long-term vision is to pioneer a novel approach to software documentation that supports automation and modularity by design. The two main objectives for the next five years are to 1) elaborate original techniques to synthesize software documentation layers automatically from synthesis hints provided by developers, and 2) devise and validate a system to present independent thematic information layers. The first objective seeks to explore a new documentation generation approach called guided synthesis. This objective will be organized in terms of sub-objectives that correspond to the guided synthesis of different thematic information layers (e.g. conceptual vs. debugging information).
The research is intended to change how we produce and consume software documentation. Documentation generated via guided synthesis is expected to be cheaper to produce and more resilient to software evolution as it can be regenerated when software is updated. By disseminating information via a modular system of thematic layers, we will create opportunities for generating documentation that closely targets specific needs. For example, layers targeted to newcomers to a technology, layers to assist debugging, or layers addressing specialized concerns such as security vulnerabilities. The deployment of research outcomes will be facilitated by our experience and infrastructure. We are currently investigating a proof of concept for embedding documentation in code and will integrate our advances directly into this system. Societal impacts will be derived from more accessible, versatile, and up-to-date software documentation. These include a lower barrier to entry into IT professions, higher software quality due to the avoidance of faults and bad designs, and better effectiveness and job satisfaction of the software development workforce. We also envision a potential commercial impact as the concept of modular documentation layers creates the conditions for the development of an ecosystem of specialized documentation producers to serve the needs of various niches of consumers.
Program
Discovery Grants Program - Individual
Recipient
Location
Quebec, Canada
Recipient Type
Academia
Type
Grant
Source
NSERC's Awards Data
As published
Application id
RGPIN-2023-03820
Name nom
Robillard, Martin
Department département
Computer Science
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
2024
Competition year année de concours
2023
Award amount
59000
Program id
RGPIN
Program name en
Discovery Grants Program - Individual
Program name fr
Programme de subventions à la découverte - individuelles
Group en
DISCOVERY RESEARCH
Group fr
RECHERCHE AXÉE SUR LA DÉCOUVERTE
Committee code
1507
Committee name en
Computer Science
Committee name fr
Sciences informatiques
Area of application code
802
Area of application group en
Information and communication services
Area of application group fr
Services d'information et de télécommunications
Area of application en
Information systems and technology
Area of application fr
Systèmes d'information et technologie de l'information
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
Field of research list names en
Not available
Field of research list names fr
Non disponible
Socioeconomic objective list names en
Not available
Socioeconomic objective list names fr
Non disponible
Application title
Generating Layered Software Documentation with Guided Synthesis
Keywords
software documentation; documentation generation; application programming interfaces; data mining; knowledge graphs; user studies
Application summary
Software documentation provides crucial information that cannot be practically encoded in the software components. Most documentation for software developers is available in a format akin to the traditional manual, where users must find a manually-created document and peruse its code examples and their explanations. A number of challenges have emerged to threaten the viability of the traditional approach to software documentation: 1) the number of software components that must be documented is growing fast; 2) the release cycle of software technology has become very short; 3) a more diverse population is now using software technologies; 4) reusable technologies are increasingly specialized, with corresponding documentation requirements.
To face these challenges, we will investigate a new approach to software documentation we call Layered Thematic Documentation. Our long-term vision is to pioneer a novel approach to software documentation that supports automation and modularity by design. The two main objectives for the next five years are to 1) elaborate original techniques to synthesize software documentation layers automatically from synthesis hints provided by developers, and 2) devise and validate a system to present independent thematic information layers. The first objective seeks to explore a new documentation generation approach called guided synthesis. This objective will be organized in terms of sub-objectives that correspond to the guided synthesis of different thematic information layers (e.g. conceptual vs. debugging information).
The research is intended to change how we produce and consume software documentation. Documentation generated via guided synthesis is expected to be cheaper to produce and more resilient to software evolution as it can be regenerated when software is updated. By disseminating information via a modular system of thematic layers, we will create opportunities for generating documentation that closely targets specific needs. For example, layers targeted to newcomers to a technology, layers to assist debugging, or layers addressing specialized concerns such as security vulnerabilities. The deployment of research outcomes will be facilitated by our experience and infrastructure. We are currently investigating a proof of concept for embedding documentation in code and will integrate our advances directly into this system. Societal impacts will be derived from more accessible, versatile, and up-to-date software documentation. These include a lower barrier to entry into IT professions, higher software quality due to the avoidance of faults and bad designs, and better effectiveness and job satisfaction of the software development workforce. We also envision a potential commercial impact as the concept of modular documentation layers creates the conditions for the development of an ecosystem of specialized documentation producers to serve the needs of various niches of consumers.