Assessing the alignment between the information needs of developers and the documentation of programming languages: A case study on Rust

02/08/2022
by   Filipe R. Cogo, et al.
0

Programming language documentation refers to the set of technical documents that provide application developers with a description of the high-level concepts of a language. Such documentation is essential to support application developers in the effective use of a programming language. One of the challenges faced by documenters (i.e., personnel that produce documentation) is to ensure that documentation has relevant information that aligns with the concrete needs of developers. In this paper, we present an automated approach to support documenters in evaluating the differences and similarities between the concrete information need of developers and the current state of documentation (a problem that we refer to as the topical alignment of a programming language documentation). Our approach leverages semi-supervised topic modelling to assess the similarities and differences between the topics of Q A posts and the official documentation. To demonstrate the application of our approach, we perform a case study on the documentation of Rust. Our results show that there is a relatively high level of topical alignment in Rust documentation. Still, information about specific topics is scarce in both the Q A websites and the documentation, particularly related topics with programming niches such as network, game, and database development. For other topics (e.g., related topics with language features such as structs, patterns and matchings, and foreign function interface), information is only available on Q A websites while lacking in the official documentation. Finally, we discuss implications for programming language documenters, particularly how to leverage our approach to prioritize topics that should be added to the documentation.

READ FULL TEXT
research
04/14/2020

An Analysis of Python's Topics, Trends, and Technologies Through Mining Stack Overflow Discussions

Python is a popular, widely used, and general-purpose programming langua...
research
10/07/2022

An Empirical Studies on How the Developers Discussed about Pandas Topics

Pandas is defined as a software library which is used for data analysis ...
research
06/11/2022

Rust: The Programming Language for Safety and Performance

Rust is a young programming language gaining increased attention from so...
research
05/05/2021

Contemporary COBOL: Developers' Perspectives on Defects and Defect Location

Mainframe systems are facing a critical shortage of developer workforce ...
research
07/03/2023

Tales from the Git: Automating the detection of secrets on code and assessing developers' passwords choices

Typical users are known to use and reuse weak passwords. Yet, as cyberse...
research
07/23/2020

Exploratory Experiments on Programming Autonomous Robots in Jadescript

This paper describes exploratory experiments to validate the possibility...

Please sign up or login with your details

Forgot password? Click here to reset