[論文レビュー] 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仕様を導出する形式的仕様生成モジュールを拡張する。
• モデルの意味論に基づいてコンポonentの振る舞いを表現する、仮定/保証形式の仕様フォーマットを用いる。
• 一貫性があり人間が読みやすい出力を得るために、事前定義済みのテンプレートを用いてLaTeX形式のFOCUS仕様を生成する。
• 構文強調、コード折りたたみ、FOCUS演算子およびフレーム用のツールボックスを備えた専用のFOCUSエディタを実装する。
• 柔軟性を確保するため、合成コンポーネント仕様のグラフィカル表現とプレーンテキスト表現の両方をサポートする。
• 形式的正しさと構造を保持しながら、生成された仕様の手動編集および最適化を可能にする。

実験結果

リサーチクエスチョン

• RQ1 システムモデルが頻繁に変更される状況において、形式的システムドキュメントを最新の状態に保つにはどうすればよいか？
• RQ2 エンジニアが実用的に行える形式的仕様の生成・編集を実現するには、どのようなツール支援が必要か？
• RQ3 形式的仕様言語に人間要因をどの程度統合できるか？
• RQ4 形式的仕様の自動生成は、システムドキュメント作成の作業量とエラー率をどれほど低減できるか？
• RQ5 形式的正確性と可読性の間で、どのようにバランスを取るべきか？

主な発見

• 提案された生成モジュールは、AutoFocusモデルから直接形式的FOCUS仕様を生成し、ドキュメントが最新のシステム状態を反映することを保証する。
• 統合されたFOCUSエディタは構文チェック、コード折りたたみ、テンプレートベースの編集をサポートし、形式的仕様の保守性を顕著に向上させる。
• 生成された仕様は仮定/保証形式で構造化されており、明確さが向上し、検証の支援が可能になる。
• ツールチェーンは、仕様の自動生成と手動での最適化の両方を可能にし、反復的開発と再利用を支援する。
• Isabelle/HOLなどの形式的検証ツールとの統合が可能であり、半自動証明構築を支援する。
• 形式的ドキュメントの作成・保守にかかる作業負荷が削減され、実務家にとって形式的技法がよりアクセスしやすくなる。