Exploranative Code Quality Documents

07/26/2019
by   Haris Mumtaz, et al.
0

Good code quality is a prerequisite for efficiently developing maintainable software. In this paper, we present a novel approach to generate exploranative (explanatory and exploratory) data-driven documents that report code quality in an interactive, exploratory environment. We employ a template-based natural language generation method to create textual explanations about the code quality, dependent on data from software metrics. The interactive document is enriched by different kinds of visualization, including parallel coordinates plots and scatterplots for data exploration and graphics embedded into text. We devise an interaction model that allows users to explore code quality with consistent linking between text and visualizations; through integrated explanatory text, users are taught background knowledge about code quality aspects. Our approach to interactive documents was developed in a design study process that included software engineering and visual analytics experts. Although the solution is specific to the software engineering scenario, we discuss how the concept could generalize to multivariate data and report lessons learned in a broader scope.

READ FULL TEXT

page 1

page 2

page 3

page 4

research
10/20/2021

JavaBERT: Training a transformer-based model for the Java programming language

Code quality is and will be a crucial factor while developing new softwa...
research
03/20/2018

Natural Language or Not (NLoN) - A Package for Software Engineering Text Analysis Pipeline

The use of natural language processing (NLP) is gaining popularity in so...
research
07/21/2020

Beyond Accuracy: Assessing Software Documentation Quality

Good software documentation encourages good software engineering, but th...
research
04/28/2010

Dimensions of Formality: A Case Study for MKM in Software Engineering

We study the formalization of a collection of documents created for a So...
research
01/13/2022

ChartText: Linking Text with Charts in Documents

Recent works show that interactive documents connecting text with visual...
research
07/31/2022

Editorial: Special Issue on Collaborative Aspects of Open Data in Software EngineeringJohan

High-quality data has become increasingly important to software engineer...

Please sign up or login with your details

Forgot password? Click here to reset