Skip to content

Commit 43a08f2

Browse files
committed
feat: add goal-question-metric example
1 parent 9f9f1b6 commit 43a08f2

4 files changed

Lines changed: 50 additions & 0 deletions

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,19 @@ This book is open to anyone interested in InnerSource, either you are
2626
applying this and you want to share your use case or you have successfully
2727
applied InnerSource in your internal software development process.
2828

29+
## How Do We Structure Goals, Questions, and Metrics?
2930

31+
Review the [Goal-Question-Metric Approach](./measuring/gqm.md) to further understand how we structure goals, questions, and metrics.
3032

33+
We document each goal in a separate folder in the [measuring](./measuring) directory. Goals link to relevant questions and metrics in the same directory.
34+
35+
*Examples:*
36+
37+
* [Example Goal](./measuring/gqm_example/gqm_example_goal.md)
38+
* [Example Question](./measuring/gqm_example/gqm_example_question.md)
39+
* [Example Metric](./measuring/gqm_example/gqm_example_metric.md)
40+
41+
We interconnect our goals, questions, and metrics. This approach not only expands our documentation of these aspects but also keeps it well-organized.
3142

3243
## References
3344

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Example Goal
2+
3+
**A short name of the goal**
4+
5+
A brief paragraph describing the goal and why it matters.
6+
7+
## Metrics
8+
9+
* [Example Metric](./gqm_example_metric.md)
10+
11+
## Questions
12+
13+
* [Example Question](./gqm_example_question.md)
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Example Metric
2+
3+
**A short name of the metric**
4+
5+
A brief description of the metric.
6+
7+
```Psuedo-code for the metric```
8+
9+
## Goals
10+
11+
[Example Goal](./gqm_example_goal.md)
12+
13+
## Questions
14+
15+
* [Example Question](./gqm_example_question.md)
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Question Example
2+
3+
**The question**
4+
5+
## Goals
6+
7+
[Example Goal](./gqm_example_goal.md)
8+
9+
## Metrics
10+
11+
[Example Metric](./gqm_example_metric.md)

0 commit comments

Comments
 (0)