What the Fix? A Study of ASATs Rule Documentation
Open Access
- 15 April 2024
- conference paper
- Published by Association for Computing Machinery (ACM)
- p. 246-257
Abstract
Automatic Static Analysis Tools (ASATs) are widely used by software developers to diffuse and enforce coding practices. Yet, we know little about the documentation of ASATs, despite it being critical to learn about the coding practices in the first place. We shed light on this through several contributions. First, we analyze the documentation of more than 100 rules of 16 ASATs for multiple programming languages, and distill a taxonomy of the purposes of the documentation---What triggers a rule; Why it is important; and how to Fix an issue---and its types of contents. Then, we conduct a survey to assess the effectiveness of the documentation in terms of its goals and types of content. We highlight opportunities for improvement in ASAT documentation. In particular, we find that the Why purpose is missing in half of the rules we survey; moreover, when the Why is present, it is more likely to have quality issues than the What and the Fix.Keywords
All Related Versions
This publication has 34 references indexed in Scilit:
- Why Do Software Developers Use Static Analysis Tools? A User-Centered Study of Developer Needs and MotivationsIEEE Transactions on Software Engineering, 2020
- How developers engage with static analysis tools in different contextsEmpirical Software Engineering, 2019
- The Adoption of JavaScript Linters in Practice: A Case Study on ESLintIEEE Transactions on Software Engineering, 2018
- Card-sorting2016
- Comparing Static Security Analysis Tools Using Open Source Software2012
- What should developers be aware of? An empirical study on the directives of API documentationEmpirical Software Engineering, 2011
- A systematic literature review of actionable alert identification techniques for automated static code analysisInformation and Software Technology, 2011
- Filtering false alarms of buffer overflow analysis using SMT solversInformation and Software Technology, 2010
- Using Static Analysis to Find BugsIEEE Software, 2008
- Taming False Alarms from a Domain-Unaware C Analyzer by a Bayesian Statistical Post AnalysisLecture Notes in Computer Science, 2005