Skip to content

Commit b3c6490

Browse files
authored
Fix markdown formatting issues (#272)
1 parent ccf2336 commit b3c6490

File tree

2 files changed

+269
-230
lines changed

2 files changed

+269
-230
lines changed

insights/metrics.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Engineering metrics
22

3+
- [Engineering metrics](#engineering-metrics)
4+
- [Purpose & usage](#purpose--usage)
5+
- [Essential metrics](#essential-metrics)
6+
- [Recommended metrics](#recommended-metrics)
7+
38
This is part of a broader [quality framework](../README.md)
49

510
## Purpose & usage
@@ -12,26 +17,26 @@ Also, these metrics are intended to be considered as part of [engineering review
1217

1318
These metrics are obviously limited to engineering concerns, and are only one part of the picture. For example, we don't want to build the wrong thing, even if we build it in a great way! We recommend that these metrics form part of a broader set of health indicators, including data relating to user satisfaction.
1419

15-
## Essential metrics:
20+
## Essential metrics
1621

1722
These metrics provide a fundamental level of insight, and so must be tracked:
1823

19-
| Measure | Definition (each calculated over the last 28 days) |
20-
|:---|:---|
21-
| Deployment frequency | Number of deployments.
22-
| Quality checks | Presence or absence of frequent, consistent, enforced (with agreed tolerances) of the [engineering quality checks](../quality-checks.md) - follow that link for further details.
24+
| Measure | Definition (each calculated over the last 28 days) |
25+
| :------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
26+
| Deployment frequency | Number of deployments. |
27+
| Quality checks | Presence or absence of frequent, consistent, enforced (with agreed tolerances) of the [engineering quality checks](../quality-checks.md) - follow that link for further details. |
2328

24-
## Recommended metrics:
29+
## Recommended metrics
2530

2631
These metrics provide useful additional insight, and are recommended to be tracked:
2732

28-
| Measure | Definition (each calculated over the last 28 days) |
29-
|:---|:---|
30-
| Lead time | Median time between an item being started to when it is done.
31-
| Change failure rate | Percentage of deployments which result in an incident.
32-
| Overall incident rate: P1 | Total number of priority 1 incidents which occurred.
33-
| Mean time to restore service: P1 | Mean time from priority 1 incident starting to when it is resolved.
34-
| Overall incident rate: P1 | Total number of priority 2 incidents which occurred.
35-
| Mean time to restore service: P2 | Mean time from priority 2 incident starting to when it is resolved.
36-
| Overall incident rate: P3 | Total number of priority 3 incidents which occurred.
37-
| Mean time to restore service: P3 | Mean time from priority 3 incident starting to when it is resolved.
33+
| Measure | Definition (each calculated over the last 28 days) |
34+
| :------------------------------- | :------------------------------------------------------------------ |
35+
| Lead time | Median time between an item being started to when it is done. |
36+
| Change failure rate | Percentage of deployments which result in an incident. |
37+
| Overall incident rate: P1 | Total number of priority 1 incidents which occurred. |
38+
| Mean time to restore service: P1 | Mean time from priority 1 incident starting to when it is resolved. |
39+
| Overall incident rate: P1 | Total number of priority 2 incidents which occurred. |
40+
| Mean time to restore service: P2 | Mean time from priority 2 incident starting to when it is resolved. |
41+
| Overall incident rate: P3 | Total number of priority 3 incidents which occurred. |
42+
| Mean time to restore service: P3 | Mean time from priority 3 incident starting to when it is resolved. |

0 commit comments

Comments
 (0)