In the development projects implemented by novices, the usefulness of the documentation in the form of comments on the final working code is minimal to guide future implementations. Such documentation does not account for novices' development process, including their choices, the errors they faced, the solutions they found, the sources they consulted, the lessons learned, and the advice to remember or give to someone else. Indeed, novices do not usually rely on their documentation to keep track of the successes and errors they find during the development process. Nevertheless, if enabled to capture various moments of the process seamlessly, novices can produce documentation that has the potential to become a valuable asset for them and other developers. This paper presents Dear Diary, a tool to support non-expert programmers in straightforwardly creating documentation artifacts directly from the IDE.

Dear Diary: On Documenting Novices' Development Process / Saenz, Juan Pablo; De Russis, Luigi. - STAMPA. - (2022), pp. 1-3. ((Intervento presentato al convegno IEEE Symposium on Visual Languages and Human-Centric Computing 2022 tenutosi a Rome, Italy nel September 12-16 [10.1109/VL/HCC53370.2022.9833003].

Dear Diary: On Documenting Novices' Development Process

Saenz, Juan Pablo;De Russis, Luigi
2022

Abstract

In the development projects implemented by novices, the usefulness of the documentation in the form of comments on the final working code is minimal to guide future implementations. Such documentation does not account for novices' development process, including their choices, the errors they faced, the solutions they found, the sources they consulted, the lessons learned, and the advice to remember or give to someone else. Indeed, novices do not usually rely on their documentation to keep track of the successes and errors they find during the development process. Nevertheless, if enabled to capture various moments of the process seamlessly, novices can produce documentation that has the potential to become a valuable asset for them and other developers. This paper presents Dear Diary, a tool to support non-expert programmers in straightforwardly creating documentation artifacts directly from the IDE.
File in questo prodotto:
File Dimensione Formato  
deardiary.pdf

accesso aperto

Tipologia: 2. Post-print / Author's Accepted Manuscript
Licenza: PUBBLICO - Tutti i diritti riservati
Dimensione 252.6 kB
Formato Adobe PDF
252.6 kB Adobe PDF Visualizza/Apri
09833003.pdf

non disponibili

Descrizione: articolo pubblicato
Tipologia: 2a Post-print versione editoriale / Version of Record
Licenza: Non Pubblico - Accesso privato/ristretto
Dimensione 953.5 kB
Formato Adobe PDF
953.5 kB Adobe PDF   Visualizza/Apri   Richiedi una copia
Pubblicazioni consigliate

I documenti in IRIS sono protetti da copyright e tutti i diritti sono riservati, salvo diversa indicazione.

Utilizza questo identificativo per citare o creare un link a questo documento: https://hdl.handle.net/11583/2964640