23-Jun-04 (Created: 23-Jun-04) | More in 'Software Architecture'

Structure of a programming pattern

Name

A descriptive name for the pattern.

Description

A paragraph of what and why.

Problem/Context

The problem context with in which this pattern operates or solves

Applicability

When is this applicable?

Structure

The structural analysis of the pattern. Static classes and their relationships.

Interactions

The dynamic nature of how the classes interact with each other to produce the pattern.

Consequences

What is the impact of using this pattern. What is the shock factor to the system or will it just slide in.

Implementation Strategies

How best to implement the pattern

Usage/Samplecode

How to use the pattern with examples. Users guide for the pattern.

Related technology

Where else is this topic discussed. What are the competing ideas. How does it compare to those?