Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add how-to pages for error notification #2

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -0,0 +1,4 @@
{
"type": "activity",
"title": "Activity"
}
@@ -0,0 +1,5 @@
---
subtitle: Design
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Develop
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Edit
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Plan
---

Coming soon
@@ -0,0 +1,5 @@
---
layout: layout/test-activity.md
---

<!-- Leave this empty -->
@@ -0,0 +1,3 @@
module.exports = {
...require('../../build/get-outcome')(__dirname)
}
5 changes: 5 additions & 0 deletions how-to/outcomes/error-notifications-described/examples.md
@@ -0,0 +1,5 @@
---
title: Examples
---

Coming soon
23 changes: 23 additions & 0 deletions 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
5 changes: 5 additions & 0 deletions how-to/outcomes/error-notifications-described/methods.md
@@ -0,0 +1,5 @@
---
layout: layout/methods.md
---

<!-- Leave this empty -->
@@ -0,0 +1,17 @@
---
subtitle: Background
---

Coming soon

### Bibliography

- [Coming soon](https://)

### Assumptions

- [Coming soon](https://)

### Accessibility Support

Coming soon
@@ -0,0 +1,8 @@
{
"method": {
"index": 1,
"title": "Explain the error in clear language",
"slug": "clear-language-errors",
"description": ""
}
}
@@ -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
```
@@ -0,0 +1,5 @@
---
subtitle: Technical Definitions
---

Coming soon
@@ -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
@@ -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
@@ -0,0 +1,3 @@
{
"type": "method"
}
5 changes: 5 additions & 0 deletions 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."
}
7 changes: 7 additions & 0 deletions how-to/outcomes/error-notifications-described/resources.md
@@ -0,0 +1,7 @@
---
title: Resources
---

## W3C Resources

Coming soon
38 changes: 38 additions & 0 deletions 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
@@ -0,0 +1,4 @@
{
"type": "activity",
"title": "Activity"
}
@@ -0,0 +1,5 @@
---
subtitle: Design
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Develop
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Edit
---

Coming soon
@@ -0,0 +1,5 @@
---
subtitle: Plan
---

Coming soon
@@ -0,0 +1,5 @@
---
layout: layout/test-activity.md
---

<!-- Leave this empty -->
@@ -0,0 +1,3 @@
module.exports = {
...require('../../build/get-outcome')(__dirname)
}
5 changes: 5 additions & 0 deletions how-to/outcomes/error-notifications-provided/examples.md
@@ -0,0 +1,5 @@
---
title: Examples
---

Coming soon
23 changes: 23 additions & 0 deletions 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
5 changes: 5 additions & 0 deletions how-to/outcomes/error-notifications-provided/methods.md
@@ -0,0 +1,5 @@
---
layout: layout/methods.md
---

<!-- Leave this empty -->
@@ -0,0 +1,17 @@
---
subtitle: Background
---

Coming soon

### Bibliography

- [Coming soon](https://)

### Assumptions

- [Coming soon](https://)

### Accessibility Support

Coming soon
@@ -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
```
@@ -0,0 +1,5 @@
---
subtitle: Technical Definitions
---

Coming soon
@@ -0,0 +1,8 @@
{
"method": {
"index": 1,
"title": "Error messages need to be discernible, consistent, and accessible",
"slug": "discernable-consistent-accessible",
"description": ""
}
}