This is an old revision of the document!
Table of Contents
Transparency
1. Acronym
The metric might be known by a short name or acronym.
2. Alternate Names
Some metrics might be known by different names, e.g. bus factor and truck factor.
3. Classification
Classifications might include: Community/Code/Risk, or Activity/Viability/Risk, or generic/composite metric
4. Description
A description of what the metric is and what it captures.
Visualization
Include a sample visualization (screenshot) of the metric
Interpretation
Provide examples of how the metric might inform different stakeholders.
5. Known Implementations
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).
6. Data Source
The orginal data source or other metric this one is building on.
7. Pseudo Code/Query
A generic calculation (code) or SQL query that generates the metric.
8. Data Exchange Format
Describe how the metric is encoded for sharing and communicating between programs.
9. References to Academic Literature
Papers released in the academic literature that uses the metric.
10. Internet References
Links to websites that add value to the understanding of the metric.
11. Contributors
Authors of the metric page and authors who made significant changes.
