技术软件文档的使用和有用性: 一个工业案例研究
a b s t r a c t
目的:我们旨在更好地了解使用和各种技术文件的有效性在软件开发和维护。
方法:我们利用以前系统制图研究的结果，并在NovAtel进行工业案例研究。从分析目标的共同定义出发，本研究方法结合了对55份文件(与设计、试验和过程有关的)和1630份文件的修订进行定性和定量分析。此外，我们还对文件的使用和有用性进行了调查。来自行业合作伙伴的共有25名工作人员参加了这次调查，他们都具有中等至高水平的经验。
结果:(1)技术文档最不常用于维护目的，而最常用于开发的信息源，(2)源代码被认为是最常作为首选信息源在软件维护,(3)在开发和维护之间没有显著差异的使用不同的文档类型,(4)初始假设说明最新信息,精度和准确性是技术文档中影响效用最高的。
结论:根据不同的目的，文档的使用是不同的，它取决于信息需求的类型以及要完成的任务(例如，开发和维护)。
-
Introduction and motivation
本文研究的技术软件文档：需求规范，设计(架构)文档，对源代码的评论，测试文档和过程描述。
本文的主要研究成果有:
（1）一种经验的方法，包括定量的和定性的评估文件和他们的修订，以评估技术软件文件的使用和有用性。
（2）对文件的使用及其与其他因素(如文件类型、工作功能、经验程度和可读性)的关系进行评估和确证性分析。
（3）对文档有用性的探索性分析。
（4）基于分析的文件编制和开发流程的改进指