copy improvement

alexewerlof · Sep 25, 2024 · 29209c1 · 29209c1
1 parent b6dd0dc
commit 29209c1
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 30 deletions.
diff --git a/views/metric-view.html b/views/metric-view.html
@@ -27,6 +27,12 @@ <h2>Symptoms</h2>
                     </tr>
                 </tbody>
             </table>
+            <div v-if="metric.measuredFailures.length === 0" class="error block">
+                <p>
+                    This metric is not tied to any failure.
+                    A good service level indicator ties to at least one possible failure symptom.
+                </p>
+            </div>
         </div>
         <div class="annotated__help">
             <p>

diff --git a/views/risk-view.html b/views/risk-view.html
@@ -1,23 +1,16 @@
 <div>
     <div class="annotated">
         <div class="annotated__controls">
-            <h2>Business Impact</h2>
-            <input type="text" v-model="failure.businessImpact">
+            <h2>Consumption</h2>
+            <p>{{ failure.consumption }}</p>
+            <h2>Symptom</h2>
+            <p>{{ failure.symptom }}</p>
+            <h2>Service</h2>
+            <p>{{ failure.service }}</p>
+            <h2>Consequence</h2>
+            {{ failure.consequence }}
         </div>
         <div class="annotated__help">
-            <p>
-                What is the business impacted when
-                {{ failure.consequence }}
-                because
-                {{ failure.symptom }} (symptom)
-                which is caused by
-                {{ failure.service.displayName }}
-                (provided by {{ failure.service.system.displayName }})
-                when
-                {{ failure.consumption.consumer.displayName }}
-                is trying to
-                {{ failure.consumption.displayName }}
-            </p>
             <code>
                 <span title="Consequence" class="exprs">
                     {{ failure.consequence }}
@@ -50,6 +43,18 @@ <h2>Business Impact</h2>
                 </span>
             </code>
         </div>
+        <div class="annotated__controls">
+            <h2>Business Impact</h2>
+            <input type="text" v-model="failure.businessImpact">
+        </div>
+        <div class="annotated__help">
+            <p>
+                What is the business impacted of this failure?
+            </p>
+            <p>
+                When thinking about the business impact, think about the money, time, and resources that are lost when this failure occurs.
+            </p>
+        </div>
     </div>
 
     <div class="annotated">
@@ -73,7 +78,11 @@ <h2>Priority</h2>
         </div>
         <div class="annotated__help">
             <p>
-                YY
+                Risk = likelihood &times; impact
+            </p>
+            <p>
+                What is the negative impact of this failure?
+                We use this setting to sort the metrics by the priority of the risks they monitor.
             </p>
         </div>
     </div>

diff --git a/views/service-metric-view.html b/views/service-metric-view.html
@@ -5,8 +5,21 @@
             <h2>Service</h2>
             <p>{{ service }}</p>
             <h2>Failures</h2>
-            <div v-for="failure of service.failures">
-                <h3>{{ failure.symptom }}</h3>
+            <div v-if="service.failures.length === 0" class="error block">
+                <p>
+                    You have not identified any failures for this service.
+                    Make sure that there is a consumption for this service and you
+                    have identified the symptoms for the failures.
+                </p>
+            </div>    
+        </div>
+    </div>
+        <div v-for="failure of service.failures" class="annotated">
+            <div class="annotated__controls">
+                <p>{{ failure.symptom }}</p>
+            </div>
+
+            <div class="annotated__help">
                 <code>
                     <span class="punct">{{ icon('because') }}</span>
                     When
@@ -59,18 +72,6 @@ <h3>{{ failure.symptom }}</h3>
                     likelihood<span class="punct">)</span>
                 </code>
             </div>
-            <div v-if="service.failures.length === 0" class="error block">
-                <p>
-                    You have not identified any failures for this service.
-                    Make sure that there is a consumption for this service and you
-                    have identified the symptoms for the failures.
-                </p>
-            </div>
-        </div>
-        <div class="annotated__help">
-            <p>
-
-            </p>
         </div>
     </div>