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 | ||
|
oss-health-metrics:metric-template [2017/05/15 15:31] GeorgLink Shortened template to currently important elements |
oss-health-metrics:metric-template [2017/10/06 21:00] (current) GeorgLink fixed link |
||
|---|---|---|---|
| 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/activity-metrics/metric-template.md | |
| - | 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} ====== | + | |
| - | + | ||
| - | ===== 1. Description ===== | + | |
| - | A description of what the metric is and what it captures. | + | |
| - | The first few sentences have to match the description in the [[oss-health-metrics:metrics||metrics list]]. | + | |
| - | + | ||
| - | ===== 2. Sample Visualization ===== | + | |
| - | Include a sample visualization (screenshot) of the metric from any implementation. | + | |
| - | + | ||
| - | ===== 3. Use Cases ===== | + | |
| - | Provide examples of how the metric might inform different stakeholders through use cases. | + | |
| - | + | ||
| - | ===== 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). | + | |
| - | + | ||
| - | ===== 6. External References (Literature) ===== | + | |
| - | Blog posts, websites, academic papers, or books that mention the metric. | + | |
oss-health-metrics/metric-template.1494862285.txt.gz · Last modified: 2017/05/15 15:31 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
