Wiki

User Tools

Site Tools

Trace:
oss-health-metrics:metric-template

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
oss-health-metrics:metric-template [2017/03/21 18:45]
GeorgLink add section "Data Exchange Format 		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. 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. +
- +
-==== 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.+
oss-health-metrics/metric-template.1490121944.txt.gz · Last modified: 2017/03/21 18:45 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
CC Attribution-Noncommercial-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki