Live software documentation of design pattern instances

To evaluate this approach, we conducted a controlled experiment with 21 novice developers. We asked participants to complete three tasks that involved <i>understanding</i> and <i>evolving</i> small software systems-up to six classes and 100 lines of code-and recorded the duration and the number of context switches. The results show that our approach helps developers spend less time understanding and documenting a software system when compared to using tools with a lower degree of liveness. Additionally, embedding documentation in the IDE and maintaining it close to the source code reduces context switching significantly.

Authors

Institutions

Publication Details

Journal
PeerJ Computer Science
Published
2024-08-16
DOI
https://doi.org/10.7717/peerj-cs.2090
Citations
4
Primary Topic
Software Engineering Research
Type
article
Field-Weighted Citation Impact
3.12
Controls
|||
ALL TIME
JAN
FEB
MAR
APR
MAY
JUN
JUL
AUG
SEP
OCT
article

Live software documentation of design pattern instances

Filipe Figueiredo Correia, Paulo Gabriel Gadelha Queiroz, Filipe Daniel Figueiredo de Lemos, Ademar Aguiar
4 citations
PeerJ Computer Science
Software Engineering Research
3.12
article

Live software documentation of design pattern instances

Filipe Figueiredo Correia, Paulo Gabriel Gadelha Queiroz, Filipe Daniel Figueiredo de Lemos, Ademar Aguiar
article en
4 citations

Abstract

To evaluate this approach, we conducted a controlled experiment with 21 novice developers. We asked participants to complete three tasks that involved <i>understanding</i> and <i>evolving</i> small software systems-up to six classes and 100 lines of code-and recorded the duration and the number of context switches. The results show that our approach helps developers spend less time understanding and documenting a software system when compared to using tools with a lower degree of liveness. Additionally, embedding documentation in the IDE and maintaining it close to the source code reduces context switching significantly.

PeerJ Computer ScienceVol. 10
Universidade do Porto (PT), INESC TEC (PT), Universidade Federal Rural do Semi-Árido (BR)
Openalex Percentile: Top 7%
Software Engineering Research
3.12
AI Navigator

Ask Laika to Summarize, Analyze, and Connect papers live on the map.

Summarize Papers & Methodologies

Extract key findings, datasets, and comparative methods across publications.

Benchmark Rankings & Visual Analytics

Rank top research institutions, authors, funders, topics, and journals by Field-Weighted Citation Impact (FWCI) and paper volume with instant charts.

Connect Distant Disciplines

Bridge topological clusters on the map to find hidden collaborative intersections.