|
| 1 | +--- |
| 2 | +name: Pattern Draft |
| 3 | +about: Suggest a new Pattern |
| 4 | +title: "[Pattern Draft]" |
| 5 | +labels: 1-initial, Type - Content Work |
| 6 | +assignees: '' |
| 7 | + |
| 8 | +--- |
| 9 | + |
| 10 | +This is the most basic template for a new pattern. |
| 11 | +See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md). |
| 12 | + |
| 13 | +## Title |
| 14 | + |
| 15 | +Short Title Here |
| 16 | + |
| 17 | +## Patlet / Summary |
| 18 | + |
| 19 | +Concise 1-2 sentence description of the problem and solution. |
| 20 | + |
| 21 | +## Problem |
| 22 | + |
| 23 | +What is the problem - crisp definition of the problem. |
| 24 | +Short description, usually not more than a couple sentences, that describes what the issues and challenges are. |
| 25 | +Be careful not to morph into information found in other sections below. |
| 26 | + |
| 27 | +## Context |
| 28 | + |
| 29 | +Where does the problem exist? |
| 30 | +What are the pre-conditions? |
| 31 | +**Unchangeable** before the solution goes into place. |
| 32 | +The content here is often tied to the applicability of the pattern for other readers: "Do I have this same particular situation?" |
| 33 | + |
| 34 | +## Forces |
| 35 | + |
| 36 | +What makes the problem difficult? |
| 37 | +What are the trade-offs? |
| 38 | +These are constraints that **can be changed** at a cost. |
| 39 | +The solution might change one or more of these forces in order to solve the problem, while also in-turn changing the context. |
| 40 | + |
| 41 | +## Solutions |
| 42 | + |
| 43 | +Verified resolutions and possible resolutions to the problem. |
| 44 | + |
| 45 | +## Resulting Context |
| 46 | + |
| 47 | +What is the situation after the problem has been solved? |
| 48 | +The original context is changed indirectly by way of the solution. |
| 49 | +Often this section can include discussion of the next possible Patterns/problems introduced. |
| 50 | +This section can be short in content - the solution may not introduce new problems or change much context. |
| 51 | + |
| 52 | +## Known Instances (optional) |
| 53 | + |
| 54 | +Where has this been seen before? |
| 55 | +Helps to reinforce that this is a REAL pattern and that you match the context. |
| 56 | + |
| 57 | +May mention: |
| 58 | + |
| 59 | +* A particular business |
| 60 | +* Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...". |
| 61 | + |
| 62 | +## Status |
| 63 | + |
| 64 | +Initial |
| 65 | + |
| 66 | +## Author(s) (optional) |
| 67 | + |
| 68 | +Often, this is yourself. |
| 69 | +If you need to, find someone in the InnerSource Commons to be the nominal author (As Told To). |
| 70 | +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