Pattern Description Guidelines

Unofficial Content
Following the definitions of What Is a Software Pattern each pattern must have:

  • Name
It is also useful to write the reason of the name. For example the Work With name came because a user first select an object to 'work with' it.
  • Intention
Describes the problem the pattern is intented to solve.
  • Canonical Example
Usually a pattern has a 'canonical' example, the most common use of it. For example in the Work With the canonical example is the Work With Customers.
  • Implementation

Describe a particular implementation of the pattern. For example a Web based Work With.


Martin Fowler has a good essay on the subject named Writing Software Patterns.