[논문 리뷰] 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명|arXiv (Cornell University)|2014. 04. 29.

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.

연구 동기 및 목표

• 소프트웨어 개발 프로젝트에서 흔히 발생하는 오래된 시스템 문서화 문제를 해결한다.
• 진행 중인 시스템 모델과 동기화되는 형식적 사양을 유지하는 과제를 해결한다.
• 엔지니어의 인지적 부담과 시간 소모를 줄여 형식적 방법의 사용성과 보급을 향상시킨다.
• 정확한 형식적 문서화를 생성하고 편집하기 위한 실용적이고 도구 지원이 되는 방법론을 제공한다.
• 형식적 사양에 인간 중심 설계 원칙을 통합하여 가독성과 유지보수성을 향상시킨다.

제안 방법

• 모델 요소에서 FOCUS 사양을 유도하는 형식적 사양 생성기를 갖춘 AutoFocus 3 CASE 도구를 확장한다.
• 모델 의미 체계에 기반한 컴포넌트 동작을 기술하기 위해 가정/보장 스타일의 사양 형식을 사용한다.
• 일관되고 인간이 읽기 쉬운 출력을 위해 사전 정의된 템플릿을 사용해 LaTeX 형식의 FOCUS 사양을 생성한다.
• 구문 강조, 코드 접기 및 FOCUS 연산자 및 프레임을 위한 도구 상자 기능을 갖춘 전용 FOCUS 편집기를 구현한다.
• 유연성을 위해 복합 컴포넌트 사양의 그래픽적 표현과 순수 텍스트 표현을 모두 지원한다.
• 형식적 정확성과 구조를 유지하면서도 생성된 사양의 수동 편집과 최적화를 가능하게 한다.

실험 결과

연구 질문

• RQ1 시스템 모델이 자주 변화할 때 형식적 시스템 문서화는 어떻게 최신 상태로 유지할 수 있는가?
• RQ2 엔지니어들이 실용적으로 형식적 사양 생성과 편집을 수행할 수 있도록 하기 위해 어떤 도구 지원이 필요한가?
• RQ3 형식적 사양 언어에 인간 요소를 얼마나 통합할 수 있는가? 이는 사용성 향상에 기여하는가?
• RQ4 자동화된 형식적 사양 생성이 시스템 문서화의 노력과 실수 비율을 얼마나 줄일 수 있는가?
• RQ5 형식적 정밀성과 가독성 사이의 균형은 어떻게 달성할 수 있는가?

주요 결과

• 제안된 생성기는 AutoFocus 모델에서 직접 형식적 FOCUS 사양을 생성하여 문서화가 최신 시스템 상태를 반영함을 보장한다.
• 통합된 FOCUS 편집기는 구문 검사, 코드 접기 및 템플릿 기반 편집을 지원하여 형식적 사양의 유지보수성을 크게 향상시킨다.
• 생성된 사양은 가정/보장 스타일로 구성되어 있어 명확성을 높이고 검증을 용이하게 한다.
• 툴체인은 사양의 자동 생성과 수동 보완을 모두 허용하여 반복적 개발과 재사용을 지원한다.
• Isabelle/HOL과 같은 형식적 검증 도구와의 통합이 가능하여 반자동 증명 구축을 지원한다.
• 형식적 문서화 작성과 유지보수의 노력이 감소하여 실무자들이 형식적 방법을 더 쉽게 접근할 수 있게 되었다.