Patterns for documenting frameworks: customization

  • Authors:

  • Ademar Aguiar;Gabriel David

  • Affiliations:

  • Universidade do Porto;Universidade do Porto

  • Venue:
  • Proceedings of the 2006 conference on Pattern languages of programs
  • Year:
  • 2006

Quantified Score

Hi-index 0.00

Visualization

Abstract

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 but comes with many issues. 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 two of a set of related patterns that describe proven solutions to help non-experts on solving recurrent problems of documenting object-oriented frameworks. The patterns here presented address the problems of describing the customization points of the framework and how such customization is supported, respectively the patterns "Customization Points" and "Design Internals".