Skip to content

Commit e9163f1

Browse files
rrrutledgerrrutledge
authored
Merge pull request #21 from jeffabailey/add-gqm-template-example
feat: add goal-question-metric example
2 parents e456094 + 4553205 commit e9163f1

File tree

5 files changed

+310
-0
lines changed

5 files changed

+310
-0
lines changed

‎README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,22 @@ 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+
Review [GQM use cases and user journeys](./measuring/gqm_example/README.md) to guide their development.
34+
35+
We document goals, questions, and metrics in separate folders in the [measuring](./measuring) directory.
36+
Goals link to all related questions, and questions link to all related metrics.
37+
38+
*Templates:*
39+
40+
* [Goal Template](./measuring/gqm_example/gqm_goal_template.md)
41+
* [Question Template](./measuring/gqm_example/gqm_question_template.md)
42+
* [Metric Template](./measuring/gqm_example/gqm_metric_template.md)
43+
44+
We interconnect our goals, questions, and metrics (GQM) in graph format. This approach not only expands our documentation of these aspects but also keeps it well-organized.
3145

3246
## References
3347

‎measuring/gqm_example/README.md

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
# What Is The Goal Question Metric (GQM) Example?
2+
3+
The GQM example is a starting point to create additional Goals, Questions, and Metrics relevant to an InnerSource Program Office (ISPO).
4+
5+
## Stakeholder Use Cases
6+
7+
The GQM example serves specific stakeholders.
8+
9+
* **Executives** use them to track the value of an InnerSource program.
10+
* **InnerSource Program Office** uses them to improve the program.
11+
* **InnerSouce Project Drivers** use them to advocate for and run their project.
12+
13+
## User Journeys
14+
15+
We use stakeholder user journeys to guide our GQM development.
16+
17+
*Here are a few user journeys:*
18+
19+
**User Journey: Measuring InnerSource Program Success with GQM as an *Executive***
20+
21+
**Step 1: Awareness and Introduction**
22+
23+
1. **User**: Executive
24+
2. **Goal**: Understand the concept of an InnerSource Program Office and its significance.
25+
3. **Actions:**
26+
* Receives communication or attends a presentation introducing the concept of InnerSource and its potential benefits.
27+
* Learn how an InnerSource Program Office can facilitate collaboration, innovation, and knowledge sharing across teams.
28+
29+
**Step 2: Understanding Goals and Objectives**
30+
31+
1. **User**: Executive
32+
2. **Goal**: Grasp the goals and objectives of the InnerSource Program Office.
33+
3. **Actions:**
34+
* Engages with documentation, presentations, or discussions that detail the goals of the InnerSource Program Office.
35+
* Learn how the program aims to foster a culture of open collaboration, reduce silos, and accelerate development through shared resources.
36+
37+
**Step 3: Exploring GQM Framework**
38+
39+
1. **User**: Executive
40+
2. **Goal**: Gain familiarity with the Goal-Question-Metric (GQM) framework and its application in measuring InnerSource program success.
41+
3. **Actions:**
42+
* Reads educational materials or attends a workshop on the GQM framework and its relevance in software development.
43+
* Understands how GQM helps define measurable objectives that align with the InnerSource Program Office's goals.
44+
45+
**Step 4: Defining Metrics for InnerSource Success**
46+
47+
1. **User**: Executive
48+
2. **Goal**: Learn how to use GQM to define specific metrics for measuring the success of the InnerSource Program Office.
49+
3. **Actions:**
50+
* Engages with resources that explain how to translate high-level InnerSource goals into measurable metrics using the GQM approach.
51+
* Collaborates with relevant teams to identify key performance indicators (KPIs) that reflect the success of InnerSource adoption.
52+
53+
**Step 5: Identifying Key Questions**
54+
55+
1. **User**: Executive
56+
2. **Goal**: Understand the importance of formulating specific questions to guide metric measurement.
57+
3. **Actions:**
58+
* Learn about the significance of crafting well-defined questions directly aligning with the InnerSource Program Office's objectives.
59+
* Collaborates with program managers to create a set of questions that will help assess the achievement of desired outcomes.
60+
61+
**Step 6: Implementing Metrics and Gathering Data**
62+
63+
1. **User**: Executive
64+
2. **Goal**: Comprehend the process of implementing defined metrics and collecting relevant data.
65+
3. **Actions:**
66+
* Participates in discussions about the practical implementation of chosen metrics across different teams and projects.
67+
* Understands the mechanisms for tracking and collecting data to evaluate progress and outcomes.
68+
69+
**Step 7: Analyzing and Interpreting Data**
70+
71+
1. **User**: Executive
72+
2. **Goal**: Gain insights into interpreting metric data and deriving actionable insights.
73+
3. **Actions:**
74+
* Reviews reports and visualizations that showcase the data collected from various metrics.
75+
* Collaborates with data analysts and program managers to understand trends, identify successes, and pinpoint areas for improvement.
76+
77+
**Step 8: Driving Continuous Improvement**
78+
79+
1. **User**: Executive
80+
2. **Goal**: Use the metric insights to drive continuous improvement of the InnerSource Program Office.
81+
3. **Actions:**
82+
* Participates in strategy sessions where metric insights guide decisions and adjustments to the InnerSource program's approach.
83+
* Collaborates with program managers to iterate on goals, questions, and metrics to ensure they remain aligned with organizational objectives.
84+
85+
**Step 9: Celebrating Success and Adapting**
86+
87+
1. **User**: Executive
88+
2. **Goal**: Recognize and celebrate achievements while remaining adaptable to changing circumstances.
89+
3. **Actions:**
90+
* Acknowledges and celebrates milestones reached due to InnerSource adoption and program success.
91+
* Remains open to adapting goals, questions, and metrics based on evolving organizational needs and the dynamic nature of software development.
92+
93+
**Step 10: Ongoing Engagement and Leadership**
94+
95+
1. **User**: Executive
96+
2. **Goal**: Maintain an ongoing commitment to InnerSource's success and leadership.
97+
3. **Actions:**
98+
* Continues engaging with program managers, teams, and stakeholders to uphold InnerSource principles.
99+
* Provides leadership and support to foster a culture of collaboration and innovation through InnerSource practices.
100+
101+
**User Journey: Measuring InnerSource Program Success with GQM as an *InnerSource Program Office***
102+
103+
**Step 1: Introduction to GQM Framework**
104+
105+
1. **User**: InnerSource Program Office
106+
2. **Goal**: Familiarize themselves with the Goal-Question-Metric (GQM) framework and its application for measuring program success.
107+
3. **Actions:**
108+
* Engages in learning materials, workshops, or training sessions that provide an overview of GQM and its relevance in software development contexts.
109+
* Understands how GQM assists in aligning goals with specific metrics to evaluate the effectiveness of the InnerSource Program.
110+
111+
**Step 2: Defining InnerSource Program Goals**
112+
113+
1. **User**: InnerSource Program Office
114+
2. **Goal**: Identify and articulate the overarching goals of the InnerSource Program.
115+
3. **Actions:**
116+
* Engages in discussions with key stakeholders to capture and formalize the strategic objectives of the InnerSource Program.
117+
* Translates high-level goals into measurable outcomes that can be used to formulate questions and metrics.
118+
119+
**Step 3: Crafting Specific Questions**
120+
121+
1. **User**: InnerSource Program Office
122+
2. **Goal**: Develop precise and actionable questions that align with the InnerSource Program's objectives.
123+
3. **Actions:**
124+
* Collaborates with stakeholders to formulate questions that address specific aspects of program success, such as collaboration, knowledge sharing, and innovation.
125+
* Ensures that each question can be answered quantitatively, facilitating effective metric measurement.
126+
127+
**Step 4: Mapping Metrics to Questions**
128+
129+
1. **User**: InnerSource Program Office
130+
2. **Goal**: Identify appropriate metrics that provide insights into the answers to the formulated questions.
131+
3. **Actions:**
132+
* Explores various metrics that can be collected and analyzed to gauge progress toward the desired outcomes.
133+
* Matches each metric to the corresponding question to create a clear link between measurement and program goals.
134+
135+
**Step 5: Implementing Data Collection**
136+
137+
1. **User**: InnerSource Program Office
138+
2. **Goal**: Establish mechanisms for collecting relevant data aligned with the identified metrics.
139+
3. **Actions:**
140+
* Collaborates with teams and departments to set up data collection processes that capture the necessary information for each metric.
141+
* Ensures data accuracy, consistency, and timeliness for accurate measurement and analysis.
142+
143+
**Step 6: Monitoring and Analyzing Metrics**
144+
145+
1. **User**: InnerSource Program Office
146+
2. **Goal**: Regularly monitor and analyze collected metric data to assess program success.
147+
3. **Actions:**
148+
* Reviews and analyzes metric data consistently, looking for trends, anomalies, and patterns.
149+
* Collaborates with data analysts to derive actionable insights and identify areas where the program excels or requires improvement.
150+
151+
**Step 7: Adjusting Program Strategy**
152+
153+
1. **User**: InnerSource Program Office
154+
2. **Goal**: Use metric insights to adapt and refine the InnerSource Program strategy.
155+
3. **Actions:**
156+
* Engages in strategic discussions to interpret metric insights and make informed decisions for optimizing program outcomes.
157+
* Collaborates with stakeholders to adjust goals, questions, and metrics based on evolving needs and changing circumstances.
158+
159+
**Step 8: Continuous Improvement and Innovation**
160+
161+
1. **User**: InnerSource Program Office
162+
2. **Goal**: Drive ongoing improvement and innovation through the insights gained from metrics.
163+
3. **Actions:**
164+
* Uses metric data to identify opportunities for process enhancements, collaboration improvements, and knowledge-sharing innovations.
165+
* Encourages teams to experiment with new approaches and adapt based on metric-driven feedback.
166+
167+
**Step 9: Communication and Reporting**
168+
169+
1. **User**: InnerSource Program Office
170+
2. **Goal**: Communicate program success, insights, and improvements to stakeholders and leadership.
171+
3. **Actions:**
172+
* Prepares regular reports and presentations that highlight metric-driven progress and accomplishments.
173+
* Ensures stakeholders are informed about how the program positively impacts collaboration, innovation, and development outcomes.
174+
175+
**Step 10: Scaling and Sustaining Success**
176+
177+
1. **User**: InnerSource Program Office
178+
2. **Goal**: Scale the successful practices and sustain the positive impact of the InnerSource Program.
179+
3. **Actions:**
180+
* Shares best practices and insights with other teams and departments, promoting the adoption of successful InnerSource principles.
181+
* Continues to apply the GQM framework to measure ongoing success, adapt to changes, and foster a culture of collaboration and innovation.
182+
183+
**User Journey: Measuring InnerSource Program Success with GQM as an *InnerSource Project Driver***
184+
185+
**Step 1: Introduction to GQM Framework**
186+
187+
1. **User**: InnerSource Project Driver
188+
2. **Goal**: Acquire a foundational understanding of the Goal-Question-Metric (GQM) framework and its applicability to measuring InnerSource Program Office success.
189+
3. **Actions:**
190+
* Engages with educational materials, workshops, or resources that introduce the concepts and principles of GQM in a software development context.
191+
* Recognizes the significance of aligning specific goals with relevant metrics to gauge program effectiveness.
192+
193+
**Step 2: Understanding InnerSource Program Office Role**
194+
195+
1. **User**: InnerSource Project Driver
196+
2. **Goal**: Comprehend the role and significance of the InnerSource Program Office within the organization.
197+
3. **Actions:**
198+
* Engages in discussions, presentations, or documentation that outline the responsibilities and objectives of the InnerSource Program Office.
199+
* Gains insights into how the success of the program office impacts collaboration, knowledge sharing, and innovation across projects.
200+
201+
**Step 3: Defining High-Level Objectives**
202+
203+
1. **User**: InnerSource Project Driver
204+
2. **Goal**: Identify and define overarching objectives for measuring the success of the InnerSource Program Office.
205+
3. **Actions:**
206+
* Collaborates with program managers and stakeholders to articulate the broad goals and outcomes the program office aims to achieve.
207+
* Ensures these objectives are clear, measurable, and aligned with the organization's strategic direction.
208+
209+
**Step 4: Formulating Targeted Questions**
210+
211+
1. **User**: InnerSource Project Driver
212+
2. **Goal**: Develop precise and relevant questions that align with the identified program office objectives.
213+
3. **Actions:**
214+
* Engages in discussions to translate high-level objectives into specific, actionable questions that address various aspects of program success.
215+
* Ensures that each question is formulated to allow for quantitative measurement and assessment.
216+
217+
**Step 5: Selecting Appropriate Metrics**
218+
219+
1. **User**: InnerSource Project Driver
220+
2. **Goal**: Choose metrics that provide meaningful insights into the answers to the formulated questions.
221+
3. **Actions:**
222+
* Explores available metrics and key performance indicators (KPIs) that align with the defined questions and objectives.
223+
* Collaborates with relevant teams and stakeholders to select the most pertinent and practical metrics for measurement.
224+
225+
**Step 6: Implementing Metric Tracking**
226+
227+
1. **User**: InnerSource Project Driver
228+
2. **Goal**: Set up mechanisms for consistently collecting and tracking metric data.
229+
3. **Actions:**
230+
* Collaborates with data analysts and technical teams to establish automated data collection processes that align with selected metrics.
231+
* Ensures that data is accurately collected, stored, and maintained for analysis.
232+
233+
**Step 7: Analyzing and Interpreting Insights**
234+
235+
1. **User**: InnerSource Project Driver
236+
2. **Goal**: Analyze the collected metric data to derive actionable insights and evaluate program office success.
237+
3. **Actions:**
238+
* Reviews metric reports and visualizations, working closely with data analysts to interpret trends and anomalies.
239+
* Gains a deeper understanding of the impact of the program office on collaboration, innovation, and project outcomes.
240+
241+
**Step 8: Collaborating for Improvement**
242+
243+
1. **User**: InnerSource Project Driver
244+
2. **Goal**: Collaborate with program stakeholders to leverage metric insights for continuous improvement.
245+
3. **Actions:**
246+
* Engages in cross-functional discussions to discuss insights and their implications for program office strategies.
247+
* Works with program managers and teams to identify opportunities for enhancing collaboration and driving innovation.
248+
249+
**Step 9: Communicating Success and Learnings**
250+
251+
1. **User**: InnerSource Project Driver
252+
2. **Goal**: Communicate metric-driven successes and lessons learned to stakeholders and the broader organization.
253+
3. **Actions:**
254+
* Prepares presentations and reports that highlight metric-driven achievements of the InnerSource Program Office.
255+
* Shares insights on how the program office's efforts have positively influenced collaboration, knowledge sharing, and project outcomes.
256+
257+
**Step 10: Fostering a Culture of Excellence**
258+
259+
1. **User**: InnerSource Project Driver
260+
2. **Goal**: Contribute to fostering a culture of excellence, continuous improvement, and innovation within the InnerSource initiative.
261+
3. **Actions:**
262+
* Continues collaborating with program managers, teams, and stakeholders to iterate on goals, questions, and metrics.
263+
* Advocates for the importance of data-driven decision-making and the ongoing role of metrics in program office success.

‎measuring/gqm_example/gqm_goal_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# **Goal:** Short name of the goal
2+
3+
A brief paragraph describing the goal and why it matters.
4+
5+
## Related Questions
6+
7+
| **Question** | **How it relates to the goal** | **Gotchas** |
8+
| --- | --- | --- |
9+
| [Example Question](./gqm_question_template.md) | Describe how the answer to this questions helps to achieve the goal. | Gotchas |

‎measuring/gqm_example/gqm_metric_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# **Metric:** Short name of the metric
2+
3+
A brief description of the metric.
4+
5+
**Synopsis**: A brief summary of the metric.
6+
7+
**Unit of Measurement**: What scale and unit of measure does the metric use?
8+
9+
**Interpretation**: What do the different values or ranges signify? For example, what does "good" or "bad" mean, or how much is "little" versus "a lot"?
10+
11+
**Measuring**
12+
13+
What input sources do you use to calculate the metric's value?
14+
15+
```Pseudo-code for the metric```

‎measuring/gqm_example/gqm_question_template.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# **Question:** A brief description of the question
2+
3+
(Optional) Add any additional description oof the question.
4+
5+
## Related Metrics
6+
7+
| **Metric** | **How it answers the question** | **Gotchas** |
8+
| --- | --- | --- |
9+
| [Example Metric](./gqm_metric_template.md) | Describe how this metric helps to answer this question. | Gotchas |

0 commit comments

Comments
 (0)