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
- Filipe Figueiredo Correia (ORCID: https://orcid.org/0000-0002-6653-1598)
- Paulo Gabriel Gadelha Queiroz (ORCID: https://orcid.org/0000-0003-3993-0208)
- Filipe Daniel Figueiredo de Lemos
- Ademar Aguiar (ORCID: https://orcid.org/0000-0002-4046-4729)
Institutions
- Universidade do Porto (PT)
- INESC TEC (PT)
- Universidade Federal Rural do Semi-Árido (BR)
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