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.
The metric might be known by a short name or acronym.
Some metrics might be known by different names, e.g. bus factor and truck factor.
Classifications might include: Community/Code/Risk, or Activity/Vaiability/Risk, or generic/composit metric
A description of what the metric is and what it captures.
Provide examples of how the metric might inform different stakeholders.
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).
The orginal data source or other metric this one is building on.
The calculation (code) or SQL query that generates the metric.
Papers released in the academic literature that uses the metric.
Links to websites that add value to the understanding of the metric.
Authors of the metric page and authors who made significant changes.