Skip to content

Commit 800c2d2

Browse files
authored
Merge pull request #23 from InnerSourceCommons/rrrutledge-patch-1
Sample goal/question/metric
2 parents 9f9f1b6 + 3c1ecd2 commit 800c2d2

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

measuring/goals/reduce-duplication.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# **Goal:** Reduce duplication
2+
3+
Why should be build things more than once?
4+
We're already busy and behind where we'd like to be.
5+
We want to build just once software that solves commmon problems and then share it widely throughout the company.
6+
7+
## Related Questions
8+
9+
| **Question** | **How it relates to the goal** | **Gotchas** |
10+
| --- | --- | --- |
11+
| [Who uses the InnerSource project?](../questions/who-uses.md) | Every instance of reduced duplication will show up as an increase in usage. | The converse is not necessarily true that every instance of increased usage is an instance of reduced duplication. It's always possible that some shared usage would have happened even without InnerSource. |

measuring/metrics/usage-count.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# **Metric:** Usage count
2+
3+
**Synopsis**: Count how many times the InnerSource project is used.
4+
Gain additional insight by gathering metadata on these usages such as business unit or timeframe.
5+
With this additional metadata we can see how lopsided or even the usage is spread across the company and across time.
6+
7+
**Unit of Measurement**: Ordinal number.
8+
9+
**Interpretation**: Higher absolute usage count is generally better.
10+
Higher diversity of usage across business unit or timeframe is generally better.
11+
12+
**Measuring**
13+
14+
If the project is an API and requires caller authentication, then read the API logs to determine the list of callers.
15+
16+
If the project is a module (or package), then scan your source control system for files that list out dependencies for a package manager to install.
17+
Here is a list of [many package managers](https://github.com/oss-review-toolkit/ort#analyzer).
18+
Look in those dependencies for usage of your InnerSource project.
19+
20+
If the project is a UI and requires login, then read the project logs to determine the list of users.

measuring/questions/who-uses.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Who uses the InnerSource project?
2+
3+
Depending on the InnerSource project, usage of the project could look something like:
4+
5+
* Inclusion of a module in a build.
6+
* Calling and API.
7+
* Visiting a UI.
8+
9+
## Related Metrics
10+
11+
| **Metric** | **How it answers the question** | **Gotchas** |
12+
| --- | --- | --- |
13+
| [Usage count](../metrics/usage-count.md) | We can see how many times an InnerSource project is reused. If there is extra information attached to that usage (like which business unit is the user) then we can see how widely across the company an InnerSource project is used. | |

0 commit comments

Comments
 (0)