This is an old revision of the document!
The following is a draft for the template that all 'Metric Detail' pages can follow.
The template is inspired by the IS Theories Wiki.
To create a new 'Metric Detail' page follow these steps:
__[[oss-health-metrics:metrics:name-of-metric|Name of Metric]]__
.oss-health-metrics:metrics:
places the page in the right location of the wiki and has to be there. A description of what the metric is and what it captures. The first few sentences have to match the description in the |metrics list.
Include a sample visualization (screenshot) of the metric from any implementation.
Provide examples of how the metric might inform different stakeholders through use cases.
A generic calculation (code) or SQL query that generates the metric.
Examples of where and how metric is used. (include links to dashboard or location where metric is visible or is talked about having been used).
Blog posts, websites, academic papers, or books that mention the metric.