1. ListentoMe: An Audio Documentation for Open Source Software.
- Author
-
Hassan Albayati, Wurood, Abdulhassan Alshomalic, Mohammad Azeez, and Holdsworth, Jason
- Subjects
DOCUMENTATION ,UNIFORM spaces - Abstract
Readme file is a short document associated with most open-source software (OSS) there were many attempts to uniform the structure of Readme file, this file is the main file most user read, it helps the user to decide upon using the software. In this paper we suggest using audio format for Readme file (ListentoMe), to do so we study the state of the art for Readme file in most popular GitHub repositories( or repos for short). 100 GitHub repositories documentation have been collected as a dataset. Extracting commits from this dataset results in 326793 messages. Next, commits regarding documentation have been isolated for further analysis. Finally, we observed the structure of readme file from the extracted commits and the number of key attributes used. The result shows that Github developers did not commit to the general Readme file structure suggested by literature [17] most developers will not save time to write documentation. Thus we suggest an audio version of Readme file named as ListentoMe, The structures for the ListentoMe file have been proposed to bridge the gap in documentation structures. To evaluate our suggestion, we conduct questionnaire targeting software developers in GitHub. The questionnaire results showed that more than 70% of developers prefer ListentoMe (audio version of Readme), they mostly agreed about the suggested ListentoMe structure. [ABSTRACT FROM AUTHOR]
- Published
- 2021
- Full Text
- View/download PDF