Patterns for effectively documenting frameworks

  • Authors:

  • Ademar Aguiar;Gabriel David

  • Affiliations:

  • INESC Porto, Departamento de Engenharia Informática, Faculdade de Engenharia da Universidade do Porto, Porto, Portugal;INESC Porto, Departamento de Engenharia Informática, Faculdade de Engenharia da Universidade do Porto, Porto, Portugal

  • Venue:
  • Transactions on pattern languages of programming II
  • Year:
  • 2011

Quantified Score

Hi-index 0.00

Visualization

Abstract

Good design and implementation are necessary but not sufficient prerequisites for successfully reusing object-oriented frameworks. Although not always recognized, good documentation is crucial for effective framework reuse, and often hard, costly, and tiresome, coming with many issues, especially when we are not aware of the key problems and respective ways of addressing them. Based on existing literature, case studies and lessons learned, the authors have been mining proven solutions to recurrent problems of documenting object-oriented frameworks, and writing them in pattern form, as patterns are a very effective way of communicating expertise and best practices. This paper presents a small set of patterns addressing problems related to the framework documentation itself, here seen as an autonomous and tangible product independent of the process used to create it. The patterns aim at helping nonexperts on cost-effectively documenting object-oriented frameworks. In concrete, these patterns provide guidance on choosing the kinds of documents to produce, how to relate them, and which contents to include. Although the focus is more on the documents themselves, rather than on the process and tools to produce them, some guidelines are also presented in the paper to help on applying the patterns to a specific framework.