Documenting Patterns
From CSSEMediaWiki
This page describes the Gang of Four style of Documenting Patterns (as referred to from Wals 324 course reader [TODO cite original source]).
The key headings and a description of each heading are listed below. [TODO add an exemplar pattern]
Contents |
Name
Intent
Brief synopsis
Motivation
The context of the problem
Applicability
Circumstances under which the pattern applies
Structure
Class diagram of solution
Participants
Explanation of the classes/objects and their roles
Collaborations
Explanation of how the classes/objects cooperate
Consequences
Discussion of impact, benefits and liabilities
Implementation
Discussion of techniques, traps, language dependent issues...
Sample Code
Known uses
Well-known systems already using the pattern
