You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: meta/pattern-template.md
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,13 +5,13 @@ Short Title Here
5
5
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
6
6
7
7
## Problem
8
-
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.
8
+
What is the problem - crisp definition of the problem. Short description, usually not more than a couple sentences, that describes what the issues and challenges are. Be careful not to morph into information found in other sections below.
9
9
10
-
## Story (Optional)
10
+
## Story (optional)
11
11
Sometimes there is a story that helps people understand the pattern better.
12
12
13
13
## Context
14
-
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?"
14
+
Where does the problem exist? What are the pre-conditions? **Unchangeable** before the solution goes into place. The content here is often tied to the applicability of the pattern for other readers: "Do I have this same particular situation?"
15
15
16
16
## Forces
17
17
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.
@@ -26,17 +26,19 @@ Verified resolutions and possible resolutions to the problem.
26
26
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.
27
27
28
28
## Rationale (optional)
29
-
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.
29
+
Explains why this is the right solution; using totally different words WHY this solution balances these forces and this context to solve this problem. Can expand on what-if's or theories.
30
30
31
-
## Known instances (optional)
31
+
## Known Instances (optional)
32
32
Where has this been seen before? Helps to reinforce that this is a REAL pattern and that you match the context
33
33
34
34
May mention:
35
35
* A particular business
36
-
*Anonymyzed instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".
36
+
*Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".
37
37
38
38
## Status (optional until merging)
39
-
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"
39
+
General pattern status is stored in GitHub's 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.
40
+
41
+
You might store other related info here, such as review history: "Three of us reviewed this on 2/5/17 and it needs John's expertise before it can go further."
40
42
41
43
## Author(s)
42
44
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)
0 commit comments