Pattern Template

^{Pattern Writing Checklist}

A noun phrase descriptive of the solution

A simple statement of the problem being solved

Define context and background to understand the problem. After reading this section, a reader should know if this is the pattern to use. Ideally closes with a question to sum up the specific problem to be solved

1. Where the problems occur?
2. What is the problem?
3. What are the factors that impact the solution of the problem?

List the issues pulling on the problem that are addressed by the solution.

1. You know you have a good set of forces when …
   1. The forces set up a tension that is resolved by the solution.
2. Rules for writing good forces
   1. Usually expressed as different directions pulling on the emerging solution.
   2. If there is only “one direction of pull”, the issue usually isn’t a force. It’s a condition or general guideline.
   3. Forces should be specific, direct statements.
   4. Forces must map directly onto the solution … different features of the solution should be seen as resolving specific forces

A specific and clear statement of the solution

Preconditions, post-conditions and things that remain true throughout application of the pattern

A fully worked-out and detailed pedagogical example

1. documented instances where the pattern has been used
2. What are known frameworks that help implement this pattern

1. List of patterns in OPL. PPPL and elsewhere that are (1) similar to this pattern or (2) are used by software based on this pattern