-
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #95 from Relequestual/docs/case-study-template
Add case study template for feedback and comments
- Loading branch information
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Case Study Template | ||
|
||
## Preface | ||
|
||
In looking to publish at least three case studies this year, we need a template of questions to ask organizations. | ||
Here are a list of questions which we should provide for each case study. | ||
The questions themselves should not be in the case study, but we should be able to put the resulting answers together should provide us with a mostly workable case study. | ||
|
||
The list is mostly based on the case study format used at https://www.cncf.io/case-studies. | ||
|
||
For each question or group of questions, before the dash is providing context, and would not be sent to the case study subject. | ||
|
||
We should always seek final approval for the case study subject before publishing. | ||
|
||
## Questions | ||
|
||
Challenge - What challenges were you encountering before you used JSON Schema? | ||
|
||
Solution - In what way did JSON Schema solve this challenge? | ||
|
||
Impact - What was the impact of the solution? What benefits have you seen? | ||
|
||
Key impact results - Are there any metrics you used to evaluate the impact or success of the project using JSON Schema? | ||
|
||
--- | ||
|
||
Who is your organization, and where do you or your group/team sit within it? | ||
|
||
What is the organization's mission? What is your group's/team's mission? | ||
|
||
What’s the organization's story that led to this work? | ||
|
||
How the challenge arose - What was the situation before the challenge presented? Was there a solution which didn’t meet new requirements? | ||
|
||
Considerations during research for a solution - What criteria did you use when deciding on potential solutions? What potential solutions did you decide were not as good a fit and why? | ||
|
||
"A Ha!" moment - What was the moment or key feature of JSON Schema that meant it was the right solution for you to try? | ||
|
||
Wider influence? - Has your/your project's use of JSON Schema had influence in other areas of the organization? | ||
|
||
What assurances do you now have? - Does JSON Schema provide you with any confidence looking forward to the future? | ||
|
||
Additional meta-data if possible: Industry, location, Size... ? |