[论文解读] Do we really need to write documentation for a system? CASE tool add-ons: generator+editor for a precise documentation

Maria Spichkova, Xiuna Zhu+1 more|arXiv (Cornell University)|Apr 29, 2014

Advanced Software Engineering Methodologies参考文献 12被引用 4

一句话总结

本文提出了一种在AutoFocus CASE工具内集成的解决方案，能够从系统模型自动生成并编辑正式的FOCUS规格说明，确保文档与设计变更保持同步。通过结合基于模型的规格说明生成器与基于模板的FOCUS编辑器，该方法减少了人工工作量，并提升了正式系统文档的可维护性。

ABSTRACT

One of the common problems of system development projects is that the system documentation is often outdated and does not describe the latest version of the system. The situation is even more complicated if we are speaking not about a natural language description of the system, but about its formal specification. In this paper we discuss how the problem could be solved by updating the documentation automatically, by generating a new formal specification from the model if the model is frequently changed.

研究动机与目标

• 解决软件开发项目中系统文档过时的普遍问题。
• 解决在系统模型不断演进时保持正式规格说明与之同步的挑战。
• 通过减轻工程师的认知负担和时间成本，提升形式化方法的可用性与采纳率。
• 提供一种实用的、工具支持的形式化文档生成与编辑方法。
• 将以人为本的设计原则整合到形式化规格说明中，以提升可读性与可维护性。

提出的方法

• 扩展AutoFocus 3 CASE工具，集成一个形式化规格说明生成器，从模型元素生成FOCUS规格说明。
• 采用前提/保证风格的规格说明格式，基于模型语义表达组件行为。
• 使用预定义模板生成LaTeX格式的FOCUS规格说明，以确保输出的一致性与可读性。
• 实现专用的FOCUS编辑器，支持语法高亮、代码折叠以及FOCUS运算符和框架的工具箱功能。
• 支持复合组件规格说明的图形化与纯文本表示，以提升灵活性。
• 在保持形式正确性与结构完整性的前提下，支持对生成规格说明的手动编辑与优化。

实验结果

研究问题

• RQ1 当系统模型频繁演化时，如何保持正式系统文档的最新状态？
• RQ2 工程师在实际应用中，需要怎样的工具支持才能使形式化规格说明的生成与编辑变得切实可行？
• RQ3 在多大程度上可以将人为因素整合到形式化规格说明语言中以提升可用性？
• RQ4 自动化生成形式化规格说明在多大程度上能够降低系统文档编写的工作量与错误率？
• RQ5 如何在系统规格说明中实现形式精确性与可读性之间的平衡？

主要发现

• 所提出的生成器可直接从AutoFocus模型生成正式的FOCUS规格说明，确保文档始终反映最新的系统状态。
• 集成的FOCUS编辑器支持语法检查、代码折叠以及基于模板的编辑，显著提升了形式化规格说明的可维护性。
• 生成的规格说明采用前提/保证风格，增强了清晰度，并有助于验证。
• 该工具链支持规格说明的自动生cheng与手动优化，支持迭代开发与复用。
• 该方法可与形式化验证工具（如Isabelle/HOL）集成，支持半自动证明构建。
• 该解决方案显著降低了编写与维护形式化文档的工作量，使形式化方法对实践者更具可及性。