Differences

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

--- oss-health-metrics:metric-template [2017/03/20 16:59]
GeorgLink remove curly brackets, added section numbers
+++ oss-health-metrics:metric-template [2017/05/18 00:11]
GeorgLink [{Name of Metric}] add back-link
@@ Line 1: / Line 1: @@
 ====== 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 =====
-====== Name of Metric ======
+To create a new 'Metric Detail' page follow these steps:
-(No text in this section - remove this text.)
-===== 1. Acronym =====
+  - In the __[[oss-health-metrics:metrics|metrics list]]__, convert the name of a metric into a link
-The metric might be known by a short name or acronym.
+    - 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.
-===== 2. Alternate Names =====
+----
-Some metrics might be known by different names, e.g. bus factor and truck factor.
-===== 3. Classification =====
+__**[[oss-health-metrics:metrics|<< Back to List of Activity Metrics]]**__
-Classifications might include: Community/Code/Risk, or Activity/Vaiability/Risk, or generic/composit metric
+====== {Name of Metric} ======
-===== 4. Description =====
+===== 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]].
-===== 5. 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.
-===== 6. Known Implementations =====
+===== 3. Sample Visualization =====
-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).
+Include a sample visualization (screenshot) of the metric from any implementation.
-===== 7. Data Source =====
+===== 4. Sample Implementation =====
-The orginal data source or other metric this one is building on.
+A generic calculation (code) or SQL query that generates the metric.
-===== 8. Code/Query =====
+===== 5. Known Implementations =====
-The calculation (code) or SQL query that generates the metric.
+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).
-===== 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 =====
+===== 6. External References (Literature) =====
-Authors of the metric page and authors who made significant changes.
+Blog posts, websites, academic papers, or books that mention the metric.

Wiki

User Tools

Site Tools

Differences

Page Tools