arrow
Return

Evaluating interactive documentation for programmers

delete2025-02-26
delete0
PRE
AI
M
Mathieu Nassif *
M
Martin P. Robillard
DOI:10.1007/s10664-025-10618-0delete
deleteOriginal
deleteOriginal request for help
deleteShare
deleteSave
Abstract

Abstract

En 中文
Documentation for software programmers is often delivered online. Yet, its format seldom leverages interactive features supported by web technologies. Researchers have proposed techniques to include interactive elements in documents. We investigated one approach, Casdoc, to understand how programmers adapt their navigation behavior to interactive documents. During the study, participants completed programming tasks that involved an unfamiliar library. They used documents that presented information in two formats: one interactive and one traditional. We analyzed recordings of the participants' usage of the documents and their answers to a post-study questionnaire to identify strengths and limitations of the two formats. We found that the interactive format helped find answers rapidly for short factual queries, whereas the traditional format was better suited to open-ended queries that required synthesizing more information. Overall, our results show the potential of leveraging alternative formats, even within the same document, to address a broader spectrum of information needs.
Keywords:
Interactive documentation
Programming tutorial
Reading patterns
Web-based documents

Journal

Empirical Software Engineering cover
Empirical Software Engineering
IF:
3.6
Papers:
2.0K
Citations:
5.3K

Organization

M
McGill University
Scholars:
5.5W
Papers: 4.9W
Citations: 7.0W
Cited Papers

Cited Papers

Documenting and sharing software knowledge using screencasts
err2017-03-30
err27
PREAI
errMacLeod, Laura; Bergen, Andreas; Storey, Margaret-Anne
errShare
errSave
errShare
errSave
errShare
errSave
errShare
errSave
Retrieving API Knowledge from Tutorials and Stack Overflow Based on Natural Language Queries
err2023-07-22
err9
errOAAI
errWu, Di; Jing, Xiao-Yuan; Zhang, Hongyu; Feng, Yang; Chen, Haowen; Zhou, Yuming; Xu, Baowen
errShare
errSave
Treatment Outcome and Relevance of Palliative Chemotherapy in Urachal Cancer
err2014-11-29
err0
PREAI
errHyun Ae Jung; Jong-Mu Sun; Se Hoon Park; Ghee Young Kwon; Ho Yeong Lim
errShare
errSave
researcher View more