Principles Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Pattern Description ======
===== Meaning 1 =====

==== Alternative Terms ====
/*i.e. alternative names meaning the same thing*/


==== Definition ====
A **pattern description** is a document that describes a pattern by giving at least the following information:
  * a name for the pattern,
  * the context in which the pattern applies,
  * the problem the pattern solves,
  * and the solution.

==== Description ====

Besides the parts mentioned above, a pattern description typically also gives a motivation, some example code,
possible variations of the pattern, known uses, etc.

The distinction between pattern and pattern description makes it clear that patterns are there---whether they are described or not. They are simply recurring solutions, that have to be described in order to communicate
them and to make them reusable. This also means that patterns normally are not constructed but discovered. Someone realizes that a recurring problem has been solved basically in the same way over and over again. And after the pattern has been found, it can be documented using a pattern description. For convenience a pattern description is often called "pattern" too. But actually it is more than that.


==== Examples ====
See the [[patterns:|list of documented patterns]] in this wiki.

==== Alternative Definitions ====
/*i.e. slightly different definitions for basically the same thing*/


==== See Also ====


==== Further Reading ====
  * [[Pattern]]
  * [[Pattern Collection]]
  * [[Pattern Catalog]]
  * [[Pattern Language]]

----
===== Other Meanings =====
/*i.e. the same term referring to something different; put short mentions here or better add more detailed descriptions as additional sections */