[Design Deliverable] Update Knowledge Center with Error Type guidance and Release Notes Email

[reitermb]

Description:

Supports #3180

AC:

• [x] Error guide page is updated with error type guidance
• [x] Screenshots are updated
• [x] The design is usable and accessible, meaning it adheres to definition of done standards for design work.

  Expand Definition of Done Standards

  - It uses [USWDS components and follows it’s UX guidance](https://designsystem.digital.gov/components/), or a deviation is clearly documented - Language is intentional and [plain](https://plainlanguage.gov/guidelines/); placeholders are clearly documented - It follows [accessibility guidelines](https://accessibility.digital.gov/) and accessibility implementation notes are documented (e.g. clear information hierarchy, color is not the only way meaning is communicated, etc.) - If feedback identifies bigger questions or unknowns, create additional issues to investigate

Tasks:

• [x] Draft content addition in gitbook
• [x] Update screenshots
• [x] Draft PR

[ADPennington]

for team awareness @victoriaatraft @reitermb @ttran-hub @lfrohlich

• this ticket will deliver KC guidance related to error type column. @klinkoberstar will support this ticket based on artifacts here
• we have some concerns about the error type description, so we think it will be important to start to provide critical guidance on these error types in the release notes. @klinkoberstar will share a working draft

[klinkoberstar]

@victoriaatraft @reitermb @ttran-hub @lfrohlich

based on discussions with @ADPennington, I've put together a starting draft of release notes.

Goals:

• Notify users that error type column exists
• Briefly introduce concept of error type
• Support users in turning on filter to view high priority errors

---

New Error Type Column Added to Error Report

To improve error identification and prioritization, a new column called "Error Type" has been added to error reports. This feature will help users quickly find and filter high-priority errors affecting file submission.

The new column categorizes errors by their priority and impact on file status. There are four types of errors.

Error Type | Priority | Impact | File Status -- | -- | -- | -- File Pre-Check | High | Entire file will be rejected. | Rejected Case Consistency | High | Record rejected. | Partially Accepted with errors Record Value Invalid | Low | Record accepted. | Accepted with errors Record Value Inconsistency | Low | Record accepted. | Accepted with errors

To filter High Priority Errors:

1. Download the Error Report.
2. Select Row 6.
3. Navigate to Data > Format, Select Filter.
4. Scroll to the right and find the Error Type column.
5. Use the filter options to prioritize:
1. File Pre-Check
2. Case Consistency

This will highlight errors that most significantly affect your file submission.

Detailed guidance on these new error types and their implications for file submissions is available in the Knowledge Center.

[klinkoberstar]

@victoriaatraft @reitermb @ttran-hub @lfrohlich

based on discussions with @ADPennington, I've put together a starting draft of KC updates.

Goals:

• Provide a detailed explanation of Error Types with examples
• Connect the dots between the error report and submission status by illustrating the series of checks that files and records go through in order to:
  • Demystify the process of error checking and generating submission status
  • Help users prioritize errors to address first by providing information on error severity
  • Provide users familiar with the legacy Fatal/Warning Edit classification with a similar indicator of severity

Note: Alex and I are working on a flow to visualize validation checks and resulting error types/file submission status which will help with the second goal; KC can be updated iteratively if this isn't ready in time

---

KC Draft Proposed Update

[victoriaatraft]

@klinkoberstar @lfrohlich Draft of the release notes/email template here on gitbook.