oss-health-metrics:metric-template
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Last revision Both sides next revision | ||
|
oss-health-metrics:metric-template [2017/03/20 16:59] GeorgLink |
oss-health-metrics:metric-template [2017/09/09 23:40] GeorgLink Page permanently moved |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====== Template for Metric ====== | ====== Template for Metric ====== | ||
| - | The following is a draft for the template that all metric detail pages can follow. | + | Page permanently moved to https://github.com/chaoss/metrics/blob/master/metric-template.md |
| - | + | ||
| - | The template is inspired by the [[https://istheory.byu.edu/wiki/Signaling|IS Theories Wiki]]. | + | |
| - | + | ||
| - | ---- | + | |
| - | + | ||
| - | ====== {Name of Metric} ====== | + | |
| - | ===== 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/Vaiability/Risk, or generic/composit metric | + | |
| - | + | ||
| - | ===== 4. Description ===== | + | |
| - | A description of what the metric is and what it captures. | + | |
| - | + | ||
| - | ===== 5. Interpretation ===== | + | |
| - | Provide examples of how the metric might inform different stakeholders. | + | |
| - | + | ||
| - | ===== 6. 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). | + | |
| - | + | ||
| - | ===== 7. Data Source ===== | + | |
| - | The orginal data source or other metric this one is building on. | + | |
| - | + | ||
| - | ===== 8. Code/Query ===== | + | |
| - | The calculation (code) or SQL query that generates the metric. | + | |
| - | + | ||
| - | ===== 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. | + | |
oss-health-metrics/metric-template.txt · Last modified: 2017/10/06 21:00 by GeorgLink
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
