Patterns for Documenting Frameworks - Part II

• Type: Article in International Conference Proceedings Book
• Date: 2006

Authors

Ademar Aguiar (Author) FEUP; Gabriel David (Author) FEUP

Conference proceedings International

Title: EuroPLoP 2006 - 11th European Conference on Pattern Languages of Programs

Pages: 393-406

11th European Conference on Pattern Languages of Programs, EuroPLoP 2006

Irsee, 5 July 2006 through 9 July 2006

Indexing

Scopus - 4 Citations

Other information

Authenticus ID: P-008-85X

DOI: 10.1145/1415472.1415491

Abstract (EN): Good design and implementation are necessary but not sufficient pre-requisites for the successful reuse of object-oriented frameworks. Although not always recognized, good documentation is crucial for effective framework reuse and comes with many issues. Defining and writing good quality documentation for a framework is often hard, costly, and tiresome, especially when not aware of its key problems and the best ways to address them. This document presents patterns from a set of related patterns that describe proven solutions to recurrent problems of documenting object-oriented frameworks. The pattern language they all form together aims at helping non-experts on cost-effectively documenting object-oriented frameworks. The patterns here presented address the problems of explaining how to use a framework and illustrating what it can be good for, respectively the patterns "COOKBOOK & RECIPES" and "GRADED EXAMPLES".

Language: English

Type (Professor's evaluation): Scientific