Add how-to pages for error notification

w3c · Jul 13, 2023 · 15bed7a · 15bed7a
1 parent bd2ee8f
commit 15bed7a
Show file tree

Hide file tree

Showing 80 changed files with 945 additions and 0 deletions.
diff --git a/how-to/outcomes/error-notifications-described/activities/activities.json b/how-to/outcomes/error-notifications-described/activities/activities.json
@@ -0,0 +1,4 @@
+{
+  "type": "activity",
+  "title": "Activity"
+}
diff --git a/how-to/outcomes/error-notifications-described/activities/design.md b/how-to/outcomes/error-notifications-described/activities/design.md
@@ -0,0 +1,5 @@
+---
+subtitle: Design
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/activities/develop.md b/how-to/outcomes/error-notifications-described/activities/develop.md
@@ -0,0 +1,5 @@
+---
+subtitle: Develop
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/activities/edit.md b/how-to/outcomes/error-notifications-described/activities/edit.md
@@ -0,0 +1,5 @@
+---
+subtitle: Edit
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/activities/plan.md b/how-to/outcomes/error-notifications-described/activities/plan.md
@@ -0,0 +1,5 @@
+---
+subtitle: Plan
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/activities/test.md b/how-to/outcomes/error-notifications-described/activities/test.md
@@ -0,0 +1,5 @@
+---
+layout: layout/test-activity.md
+---
+
+<!-- Leave this empty -->
diff --git a/how-to/outcomes/error-notifications-described/error-notifications-described.11tydata.js b/how-to/outcomes/error-notifications-described/error-notifications-described.11tydata.js
@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../build/get-outcome')(__dirname)
+}
diff --git a/how-to/outcomes/error-notifications-described/examples.md b/how-to/outcomes/error-notifications-described/examples.md
@@ -0,0 +1,5 @@
+---
+title: Examples
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/index.md b/how-to/outcomes/error-notifications-described/index.md
@@ -0,0 +1,23 @@
+---
+title: Get Started
+---
+
+<div class="normative">
+  <p>{{ outcome.description }}</p>
+</div>
+
+## Summary
+
+Coming soon
+
+## Why
+
+Coming soon
+
+## Who it helps
+
+Coming soon
+
+## How
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/methods.md b/how-to/outcomes/error-notifications-described/methods.md
@@ -0,0 +1,5 @@
+---
+layout: layout/methods.md
+---
+
+<!-- Leave this empty -->
diff --git a/...comes/error-notifications-described/methods/clear-language-errors/background.md b/...comes/error-notifications-described/methods/clear-language-errors/background.md
@@ -0,0 +1,17 @@
+---
+subtitle: Background
+---
+
+Coming soon
+
+### Bibliography
+
+- [Coming soon](https://)
+
+### Assumptions
+
+- [Coming soon](https://)
+
+### Accessibility Support
+
+Coming soon
diff --git a/...es/error-notifications-described/methods/clear-language-errors/clear-language-errors.json b/...es/error-notifications-described/methods/clear-language-errors/clear-language-errors.json
@@ -0,0 +1,8 @@
+{
+  "method": {
+    "index": 1,
+    "title": "Explain the error in clear language",
+    "slug": "clear-language-errors",
+    "description": ""
+  }
+}
diff --git a/...es/error-notifications-described/methods/clear-language-errors/code-snippets.md b/...es/error-notifications-described/methods/clear-language-errors/code-snippets.md
@@ -0,0 +1,33 @@
+---
+subtitle: Code Snippets
+---
+
+### Passed
+
+#### Passed Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
+
+### Failed
+
+#### Failed Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
+
+### Inapplicable
+
+#### Inapplicable Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
diff --git a/...omes/error-notifications-described/methods/clear-language-errors/definitions.md b/...omes/error-notifications-described/methods/clear-language-errors/definitions.md
@@ -0,0 +1,5 @@
+---
+subtitle: Technical Definitions
+---
+
+Coming soon
diff --git a/...o/outcomes/error-notifications-described/methods/clear-language-errors/index.md b/...o/outcomes/error-notifications-described/methods/clear-language-errors/index.md
@@ -0,0 +1,26 @@
+---
+subtitle: Introduction
+---
+
+*   Discussion of how to handle a situation where there is only one Method. We agreed that if there are multiple methods, we can articulate which combinations of methods are satisfactory to meet the outcome, or it can be one outcome, one method.
+
+*   When creating outcomes, there is an ongoing question about when to break apart outcomes and when to combine related requirements. The advantage of breaking outcomes apart is that separate outcomes raise awareness of needs and ensure critical parts are not hidden at lower levels of documentation. The disadvantage of creating separate outcomes is the sheer number of resulting outcomes which may feel overwhelming. Groups should remain aware of this tension and document the rationale for breaking outcomes apart. Conversely, combining outcomes as “outcome A and outcome B” may result in outcome B being overlooked
+
+### Summary
+
+Coming soon
+
+<dl class="method-card">
+  <div>
+    <dt>Platform:</dt>
+    <dd>Any platform supporting HTML</dd>
+  </div>
+  <div>
+    <dt>Technology:</dt>
+    <dd>HTML</dd>
+  </div>
+</dl>
+
+### How it solves user need
+
+Coming soon
diff --git a/...to/outcomes/error-notifications-described/methods/clear-language-errors/test.md b/...to/outcomes/error-notifications-described/methods/clear-language-errors/test.md
@@ -0,0 +1,17 @@
+---
+subtitle: Test
+---
+
+1.  Identify the type of error that has occurred
+
+2.  Identify where the error has occurred
+
+3.  The error message is written in clear language or has a link to a clear language explanation. “Error 10752” is a fail.
+
+### Applicability
+
+Coming soon
+
+### Expectation
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/methods/methods.json b/how-to/outcomes/error-notifications-described/methods/methods.json
@@ -0,0 +1,3 @@
+{
+  "type": "method"
+}
diff --git a/how-to/outcomes/error-notifications-described/outcome.json b/how-to/outcomes/error-notifications-described/outcome.json
@@ -0,0 +1,5 @@
+{
+  "index": 0,
+  "title": "Notifications describe errors",
+  "description": "Provides a clear message describing the error so users understand the cause of the error."
+}
diff --git a/how-to/outcomes/error-notifications-described/resources.md b/how-to/outcomes/error-notifications-described/resources.md
@@ -0,0 +1,7 @@
+---
+title: Resources
+---
+
+## W3C Resources
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-described/user-needs.md b/how-to/outcomes/error-notifications-described/user-needs.md
@@ -0,0 +1,38 @@
+---
+title: User Needs
+---
+
+<div class="normative">
+  <p>{{ outcome.description }}</p>
+</div>
+
+## Barriers Encountered
+
+*   No description of cause of error
+*   Unhelpful description of cause of error error
+*   Error description that is not understandable (e.g., not clear)
+
+## Common User Needs
+
+*   Error message describes the error: User needs an error message describing the error so they know what went wrong.
+
+## Unique User Needs
+
+*   N/A
+
+## Functional Needs
+
+*   Essential
+*   Sensory - Vision and Visual
+*   Sensory - Sensory Intersections
+*   Cognitive - Attention
+*   Cognitive - Language and Literacy
+*   Cognitive - Learning
+*   Cognitive - Memory
+*   Cognitive - Executive
+*   Cognitive - Mental Health
+*   Cognitive - Cognitive and Sensory Intersections
+*   Independence
+*   Physical - Mobility
+*   Physical - Motor
+*   Physical & Sensory Intersections
diff --git a/how-to/outcomes/error-notifications-provided/activities/activities.json b/how-to/outcomes/error-notifications-provided/activities/activities.json
@@ -0,0 +1,4 @@
+{
+  "type": "activity",
+  "title": "Activity"
+}
diff --git a/how-to/outcomes/error-notifications-provided/activities/design.md b/how-to/outcomes/error-notifications-provided/activities/design.md
@@ -0,0 +1,5 @@
+---
+subtitle: Design
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/activities/develop.md b/how-to/outcomes/error-notifications-provided/activities/develop.md
@@ -0,0 +1,5 @@
+---
+subtitle: Develop
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/activities/edit.md b/how-to/outcomes/error-notifications-provided/activities/edit.md
@@ -0,0 +1,5 @@
+---
+subtitle: Edit
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/activities/plan.md b/how-to/outcomes/error-notifications-provided/activities/plan.md
@@ -0,0 +1,5 @@
+---
+subtitle: Plan
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/activities/test.md b/how-to/outcomes/error-notifications-provided/activities/test.md
@@ -0,0 +1,5 @@
+---
+layout: layout/test-activity.md
+---
+
+<!-- Leave this empty -->
diff --git a/how-to/outcomes/error-notifications-provided/error-notifications-provided.11tydata.js b/how-to/outcomes/error-notifications-provided/error-notifications-provided.11tydata.js
@@ -0,0 +1,3 @@
+module.exports = {
+  ...require('../../build/get-outcome')(__dirname)
+}
diff --git a/how-to/outcomes/error-notifications-provided/examples.md b/how-to/outcomes/error-notifications-provided/examples.md
@@ -0,0 +1,5 @@
+---
+title: Examples
+---
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/index.md b/how-to/outcomes/error-notifications-provided/index.md
@@ -0,0 +1,23 @@
+---
+title: Get Started
+---
+
+<div class="normative">
+  <p>{{ outcome.description }}</p>
+</div>
+
+## Summary
+
+Coming soon
+
+## Why
+
+Coming soon
+
+## Who it helps
+
+Coming soon
+
+## How
+
+Coming soon
diff --git a/how-to/outcomes/error-notifications-provided/methods.md b/how-to/outcomes/error-notifications-provided/methods.md
@@ -0,0 +1,5 @@
+---
+layout: layout/methods.md
+---
+
+<!-- Leave this empty -->
diff --git a/...-notifications-provided/methods/discernable-consistent-accessible/background.md b/...-notifications-provided/methods/discernable-consistent-accessible/background.md
@@ -0,0 +1,17 @@
+---
+subtitle: Background
+---
+
+Coming soon
+
+### Bibliography
+
+- [Coming soon](https://)
+
+### Assumptions
+
+- [Coming soon](https://)
+
+### Accessibility Support
+
+Coming soon
diff --git a/...tifications-provided/methods/discernable-consistent-accessible/code-snippets.md b/...tifications-provided/methods/discernable-consistent-accessible/code-snippets.md
@@ -0,0 +1,33 @@
+---
+subtitle: Code Snippets
+---
+
+### Passed
+
+#### Passed Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
+
+### Failed
+
+#### Failed Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
+
+### Inapplicable
+
+#### Inapplicable Example 1
+
+Coming soon
+
+```html
+Code snippet
+```
diff --git a/...notifications-provided/methods/discernable-consistent-accessible/definitions.md b/...notifications-provided/methods/discernable-consistent-accessible/definitions.md
@@ -0,0 +1,5 @@
+---
+subtitle: Technical Definitions
+---
+
+Coming soon
diff --git a/...provided/methods/discernable-consistent-accessible/discernable-consistent-accessible.json b/...provided/methods/discernable-consistent-accessible/discernable-consistent-accessible.json
@@ -0,0 +1,8 @@
+{
+  "method": {
+    "index": 1,
+    "title": "Error messages need to be discernible, consistent, and accessible",
+    "slug": "discernable-consistent-accessible",
+    "description": ""
+  }
+}