Does Documentation Matter? An Empirical Study of Practitioners' Perspective on Open-Source Software Adoption

Fuente: arXiv
Saved in:
Bibliographic Details
Main Authors: Imani, Aaron, Radmanesh, Shiva, Ahmed, Iftekhar, Moshirpour, Mohammad
Format: Preprint
Published: 2024
Subjects:
Online Access:
Tags: Add Tag
No Tags, Be the first to tag this record!
_version_ 1866913256368504832
author Imani, Aaron
Radmanesh, Shiva
Ahmed, Iftekhar
Moshirpour, Mohammad
author_facet Imani, Aaron
Radmanesh, Shiva
Ahmed, Iftekhar
Moshirpour, Mohammad
contents In recent years, open-source software (OSS) has become increasingly prevalent in developing software products. While OSS documentation is the primary source of information provided by the developers' community about a product, its role in the industry's adoption process has yet to be examined. We conducted semi-structured interviews and an online survey to provide insight into this area. Based on interviews and survey insights, we developed a topic model to collect relevant information from OSS documentation automatically. Additionally, according to our survey responses regarding challenges associated with OSS documentation, we propose a novel information augmentation approach, DocMentor, by combining OSS documentation corpus TF-IDF scores and ChatGPT. Through explaining technical terms and providing examples and references, our approach enhances the documentation context and improves practitioners' understanding. Our tool's effectiveness is assessed by surveying practitioners.
format Preprint
id arxiv_https___arxiv_org_abs_2403_03819
institution arXiv
publishDate 2024
record_format arxiv
spellingShingle Does Documentation Matter? An Empirical Study of Practitioners' Perspective on Open-Source Software Adoption
Imani, Aaron
Radmanesh, Shiva
Ahmed, Iftekhar
Moshirpour, Mohammad
Software Engineering
In recent years, open-source software (OSS) has become increasingly prevalent in developing software products. While OSS documentation is the primary source of information provided by the developers' community about a product, its role in the industry's adoption process has yet to be examined. We conducted semi-structured interviews and an online survey to provide insight into this area. Based on interviews and survey insights, we developed a topic model to collect relevant information from OSS documentation automatically. Additionally, according to our survey responses regarding challenges associated with OSS documentation, we propose a novel information augmentation approach, DocMentor, by combining OSS documentation corpus TF-IDF scores and ChatGPT. Through explaining technical terms and providing examples and references, our approach enhances the documentation context and improves practitioners' understanding. Our tool's effectiveness is assessed by surveying practitioners.
title Does Documentation Matter? An Empirical Study of Practitioners' Perspective on Open-Source Software Adoption
topic Software Engineering
url https://arxiv.org/abs/2403.03819