id: 05924157
dt: a
an: 05924157
au: Aguiar, Ademar; David, Gabriel
ti: Patterns for effectively documenting frameworks.
so: Noble, James (ed.) et al., Transactions on Pattern Languages of Programming
    II. Special issue on applying patterns. Berlin: Springer (ISBN
    978-3-642-19431-3/pbk). Lecture Notes in Computer Science 6510. Journal
    Subline, 79-124 (2011).
py: 2011
pu: Berlin: Springer
la: EN
cc: 
ut: patterns; object-oriented frameworks; documentation
ci: 
li: doi:10.1007/978-3-642-19432-0_5
ab: Summary: Good design and implementation are necessary but not sufficient
    pre-requisites 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 non-experts 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.
rv: