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.

Sign up for GitHub

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

Jump to bottom

Improve copy of Error messages #53095

Open
hanneslsm opened this issue Jul 28, 2023 · 4 comments
Open

Improve copy of Error messages #53095

hanneslsm opened this issue Jul 28, 2023 · 4 comments
Labels
[Feature] Template Editing Mode Related to the template editor available in the Block Editor General Interface Parts of the UI which don't fall neatly under other labels. [Type] Enhancement A suggestion for improvement.

Comments

@hanneslsm
Copy link

hanneslsm commented Jul 28, 2023 •
edited

What problem does this address?

When saving fails, the Copy is from a UX standpoint very poor:
image

It's missing at least the info on what exactly has happened and what to do next.
I'd love to give more information on how to reproduce the error message and give suggestions on how to improve, but ironically I don't have any more information 😄

Maybe this caused the error? A small improvement would be to console errors to give more info - would this be possible?
image

What is your proposed solution?

This is a good basic guide on better copywriting for error messages: https://www.thegiggal.com/ux-writing-error-messages/
@hanneslsm
Copy link
Author

I think the Saving issue came up because my template was called "Temp: Heros". After removing the : it disappeared.
Proofs the point that the copy of error message must be improved.

@skorasaurus skorasaurus added the General Interface Parts of the UI which don't fall neatly under other labels. label Jul 28, 2023
@skorasaurus
Copy link
Member

I wholeheartedly agree. When I first started developing in Gutenberg (already 3-4 years ago!), the ambiguity of the error message was really frustrating and this largely hasn't changed; I just know now where to look (console, using breakpoints, etc), what typical error message in Gutenberg can mean, and to developers' credit, fewer overall errors.

Related issues to improve error messages clarity: #34482 , #34119, #10492 , and #25436

@skorasaurus skorasaurus added the [Feature] Template Editing Mode Related to the template editor available in the Block Editor label Jul 28, 2023
@skorasaurus
Copy link
Member

skorasaurus commented Jul 28, 2023 •
edited

(Perhaps for this issue, to keep it on track and make it actionable; surface a message that only certain characters are allowed in template names.

@jordesign jordesign added the [Type] Enhancement A suggestion for improvement. label Aug 1, 2023
@hanneslsm hanneslsm mentioned this issue Feb 12, 2024
Merged
@hanneslsm
Copy link
Author

(Perhaps for this issue, to keep it on track and make it actionable; surface a message that only certain characters are allowed in template names.

Actually, I think it'd be beneficial if we keep this issue for general UX and Copy improvement for error messages. The error above was only an example.

To move forward, we'd probably need more information on which information could be extracted. Even small improvements, like the displaying the error message from the console, would help already.
We then can see if the copy can be more polished and made more human, so to say.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
[Feature] Template Editing Mode Related to the template editor available in the Block Editor General Interface Parts of the UI which don't fall neatly under other labels. [Type] Enhancement A suggestion for improvement.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@skorasaurus @jordesign @hanneslsm