探索性解释型代码质量文档

良好的代码质量是高效开发可维护软件的先决条件。在本文中，我们提出了一种新颖的方法，用于生成探索性解释型（解释性与探索性）数据驱动文档，在交互式、可探索的环境中报告代码质量。我们采用基于模板的自然语言生成方法，根据软件度量的数据创建关于代码质量的文本解释。该交互式文档通过多种可视化形式得以丰富，包括用于数据探索的平行坐标图和散点图，以及嵌入文本中的图形。我们设计了一种交互模型，允许用户在文本与可视化之间以一致的链接来探索代码质量；通过集成的解释性文本，向用户传授关于代码质量方面的背景知识。我们的交互式文档方法是在一个包含软件工程与视觉分析专家的设计研究过程中开发的。尽管该解决方案特定于软件工程场景，我们讨论了该概念如何推广到多变量数据，并汇报了更广泛范围内的经验教训。