The software reuse is widely believed to be a key factor for improving software productivity as well as quality. One of the technologies promoting the reuse is object oriented frameworks, which can facilitate large scale reuse.
Unfortunately, frameworks often pose a steep learning curve. To alleviate this problem, a documentation scheme for frameworks should consider specific aspects of frameworks. In this thesis, we propose a documentation scheme for frameworks. First, to propose an appropriate documentation scheme, we identify three major problems arising from documenting a framework: (1) the changed role of developers, (2) the difficulty of understanding the behavior of a framework, and (3) the size of the collection of many, seemingly unrelated classes in a framework. Our documentation scheme consists of three parts: overview, structural patterns, and behavioral patterns. We focus on representing collaborations among classes as a concrete work product to capture the delocalized strategy and providing a higher-level abstraction than classes and their methods. And we demonstrate a design process based on the proposed documentation scheme to show the effectiveness of our approach.
소프트웨어 재사용은 소프트웨어 품질 향상 뿐아니라 생산성 향상을 얻기 위한 중요한 요소로 인식되고 있다. 객체 지향 프레임워크는 재사용을 증진시키는 기법으로, 큰 규모의 재사용을 제공하기 때문에 주목받는 객체 지향 재사용 기술 중의 하나이다.
그러나 객체 지향 프레임워크는 익히는 데 많은 시간이 필요하다는 문제점을 가지고 있다. 이러한 문제를 해결하는 방법의 하나로 본 논문에서는 객체 지향 프레임워크를 위한 문서화 방안을 제안하였다. 먼저, 적절한 문서화 방안을 제안하기 위해서 프레임워크를 문서화하는 과정에서 발생하는 주요한 세가지 문제점들- (1) 개발자 역할의 변경, (2) 프레임워크 동작의 난해성, (3) 프레임워크 규모의 방대함 -을 파악하였다. 제시된 문서화 기법은 overview, structural patterns, behavioral patterns의 세 부분으로 구성되었다. 이러한 문서화 기법을 제시함으로써, 프레임워크 개발자의 분산된 의도를 개발자에게 제공하기 위해서 클래스간의 상호 작용을 명확히 표현하고자 하였으며, 클래스와 메소드 보다 상위 수준의 추상화를 제공하고자 하였다. 마직막으로 제안된 문서화 기법에 기반한 설계의 과정을 보임으로써 제안된 방법의 효율성을 보였다.
