Short Title Here
Concise 1-2 sentence description of the problem and solution. Readers may quickly review dozens of these patlets to discover and browse the larger library of patterns. From http://wiki.c2.com/?PatLet
What is the problem - crisp definition of the problem. Short description, usually not more than a couple sentances, that describes what the issues and challenges are. Be careful not to morph into information found in other sections below.
Sometimes there is a story that helps people understand the pattern better.
Where does the problem exist? what are the pre-conditions? Unchangeable before the solution goes into place. The content here is often tied to applicability of other readers: "Do I have this same particular situation?"
What makes the problem difficult? What are the trade-offs? These are constraints that can be changed at a cost. The solution might change one or more of these forces in order to solve the problem, while also in-turn changing the context.
Verified resolutions and possible resolutions to the problem.
What is the situation after the problem has been solved? The original context is changed indirectly by way of the solution. Often this section can include discussion of the next possible Patterns/problems introduced. This section can be short in content - the solution may not introduce new problems or change much context.
Explains why this is the right solution; using totally different words WHY this solution balances these force and this context to solve this problem. Can expand on what-if's or theories.
Known instances (optional)
Where has this been seen before? Helps to reinforce that this is a REAL pattern and that you match the context
- A particular business
- Anonymyzed instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".
Status (optional until merging)
General pattern status is stored in githubs Label tagging - see any pull request. Note that this github label tagging becomes less visible once the pattern is finalized and merged, so having some information in this field is helpful. You might store other related info here info, such as review history: "Three of us reviewed this on 2/5/17 and it needs Johns expertise before it can go further"
Often, this is yourself; If you need to, find someone in the InnerSource Commons to be the nominal author (As Told To); Could also be no-one if you do not want to take on authorship (common with a donut looking for a solution)
Include those who assisted in helping with this pattern - both for attribution and for possible future follow up. Though optional, most patterns should list who helped in their creation.