[论文解读] What's the point of documentation?

Louise Pryor|arXiv (Cornell University)|Nov 3, 2010

Spreadsheets and End-User Computing参考文献 1被引用 5

一句话总结

本文研究了文档在电子表格中的作用与价值，主张有效的文档能够提升电子表格开发中的透明度、可维护性和正确性。通过对其使用实践的定性分析，本文识别出关键的文档形式，如注释、标签和结构，展示了它们如何减少错误并改善协作，其核心贡献是为电子表格工作中的有意文档化提供了一个框架。

ABSTRACT

We give a brief characterisation of the purposes and forms of documentation in and of spreadsheets.

研究动机与目标

• 理解电子表格开发中文档化的动机及其对用户而言的感知价值。
• 识别在电子表格中使用的文档形式与类型，特别是在真实世界或工业环境中的应用。
• 研究文档如何有助于减少电子表格应用中的错误并提高可维护性。
• 为电子表格环境中的有效文档实践提供一个结构化框架。
• 倡导将有意文档化作为电子表格软件工程中的核心实践，类似于传统编程中的编码规范。

提出的方法

• 基于观察到的和报告的用户行为，对电子表格实践进行定性分析。
• 考察电子表格文档的具体示例，包括注释、单元格标签和结构化组织。
• 借助案例研究和行业报告，说明文档如何支持理解与维护。
• 利用欧洲电子表格风险小组（EuSpRIG）的见解，将发现建立在真实世界电子表格风险与失败的基础上。
• 提出与电子表格相关的文档类型分类法，强调清晰性、可追溯性和可审计性。
• 强调文档在减少错误方面的作用，尤其是在复杂或共享的电子表格环境中。

实验结果

研究问题

• RQ1 电子表格应用中文档化的主要目的是什么？
• RQ2 用户目前如何在其电子表格工作流中实施文档化？
• RQ3 文档在多大程度上提升了电子表格的可靠性和可维护性？
• RQ4 电子表格开发中缺乏或缺失文档会带来哪些后果？
• RQ5 如何系统性地将文档整合到电子表格的设计与使用中以预防错误？

主要发现

• 电子表格中的文档显著降低了错误风险，通过提升逻辑与数据的清晰度和可追溯性。
• 注释、标签和结构化布局是提升理解力最有效的文档形式。
• 在工业和学术环境中，缺乏文档经常被列为电子表格错误的根本原因。
• 有效的文档支持协作、可审计性以及电子表格模型的长期可维护性。
• 缺乏标准化的文档实践会增加数据损坏和误解的风险。
• 有意文档化在电子表格开发中的重要性，与传统软件工程中的版本控制或测试同等关键。