oss-health-metrics:metric-template
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
oss-health-metrics:metric-template [2017/03/20 16:55] GeorgLink created |
oss-health-metrics:metric-template [2017/05/15 15:32] GeorgLink swap 2 and 3 |
||
|---|---|---|---|
| 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. | + | The following is a draft for the template that all 'Metric Detail' pages can follow. |
| - | The template is inspired by the [[https://istheory.byu.edu/wiki/Signaling|IS Theories Wiki]]. | + | The template is inspired by the __[[https://istheory.byu.edu/wiki/Signaling|IS Theories Wiki]]__. |
| + | |||
| + | ===== Instructions ===== | ||
| + | |||
| + | To create a new 'Metric Detail' page follow these steps: | ||
| + | |||
| + | - In the __[[oss-health-metrics:metrics|metrics list]]__, convert the name of a metric into a link | ||
| + | - The link looks like this: ''%%__[[oss-health-metrics:metrics:name-of-metric|Name of Metric]]__%%''. | ||
| + | - **Important:** The namespace ''oss-health-metrics:metrics:'' places the page in the right location of the wiki and has to be there. | ||
| + | - Before the verticle bar, the //Name of Metric// should be lower case and spaces replaced by hyphens. | ||
| + | - Copy the text below the horizontal bar into the new wiki page. | ||
| + | - Remove explanations in all sections and leave sections empty if no information is available at the moment. | ||
| + | - **Important:** Do not delete a section heading because we want all 'Metric Detail' pages to be structured the same. | ||
| + | |||
| + | |||
| + | ---- | ||
| ====== {Name of Metric} ====== | ====== {Name of Metric} ====== | ||
| - | (no text in this section) | + | |
| - | ===== {Acronym} ===== | + | ===== 1. Description ===== |
| - | The metric might be known by a short name or acronym. | + | |
| - | ===== {Alternate Names} ===== | + | |
| - | Some metrics might be known by different names, e.g. bus factor and truck factor. | + | |
| - | ===== {Description} ===== | + | |
| A description of what the metric is and what it captures. | A description of what the metric is and what it captures. | ||
| - | ===== {Classification} ===== | + | The first few sentences have to match the description in the [[oss-health-metrics:metrics||metrics list]]. |
| - | Classifications might include: Community/Code/Risk, or Activity/Vaiability/Risk, or generic/composit metric | + | |
| - | ===== {Interpretation} ===== | + | ===== 2. Use Cases ===== |
| - | Provide examples of how the metric might inform different stakeholders. | + | Provide examples of how the metric might inform different stakeholders through use cases. |
| - | ===== {Known Implementations} ===== | + | |
| + | ===== 3. Sample Visualization ===== | ||
| + | Include a sample visualization (screenshot) of the metric from any implementation. | ||
| + | |||
| + | ===== 4. Sample Implementation ===== | ||
| + | A generic calculation (code) or SQL query that generates the metric. | ||
| + | |||
| + | ===== 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). | 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). | ||
| - | ===== {Source} ===== | + | |
| - | The orginal data source or other metric this one is building on. | + | ===== 6. External References (Literature) ===== |
| - | ===== {Code/Query} ===== | + | Blog posts, websites, academic papers, or books that mention the metric. |
| - | The calculation (code) or SQL query that generates the metric. | + | |
| - | ===== {References to Academic Literature} ===== | + | |
| - | Papers released in the academic literature that uses the metric. | + | |
| - | ===== {Internet References} ===== | + | |
| - | Links to websites that add value to the understanding of the metric. | + | |
| - | ===== {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
