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

[UX] Providing effective user feedback guidelines #198

Open
wants to merge 26 commits into
base: 5.x
Choose a base branch
from

Conversation

andersonjeccel
Copy link
Contributor

This pull request updates the Mautic documentation to include detailed guidelines on handling "No Results" scenarios.

It introduces the "No Results" template, explaining its structure and parameters, and emphasizes the importance of visibility, transparency, and orientation to enhance user experience.

The documentation provides practical implementation guidelines with examples for creating informative messages, calls-to-action (CTAs), and contextual explanations.

@favour-chibueze
Copy link
Contributor

favour-chibueze commented Jul 25, 2024

@andersonjeccel @RCheesley Please, check this

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey folks!

I love the content in this PR, it really does help developers to understand how to do things better. Thanks @andersonjeccel !

I've made some suggestions, some common themes were:

  • I think we should be consistent with using double quotes only for spoken speech and single quotes for everything else,
  • Inline code needs to have two backticks, not one
  • There were a few Vale issues outstanding which I've proposed fixes for
  • A couple of places using 'enable/enabled' which I've suggested a more inclusive phrase for
  • I think we don't need to capitalise Call To Action in a sentence, I think it's fine lower case.
  • A couple of Vale corrections which are wonky - Form and Points when you're not referring to the physical Mautic features, suggest turning off Vale for that para.

docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
andersonjeccel and others added 16 commits July 25, 2024 13:41
Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just have a few small nitpicks with this now, but I really appreciate the content and think we can get this ready to merge pretty fast.

docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved
docs/design/feedback.rst Outdated Show resolved Hide resolved

It ensures a uniform presentation of 'no results' messages across the platform, providing consistency in the User experience. Its flexibility allows use in various situations, from empty lists to graphs without data, adapting to different contexts. The optional link makes the template actionable, guiding the User to actions that can resolve the 'no results' situation, promoting engagement and problem resolution. Additionally, support for internationalization translates messages into different languages, making the platform more globally accessible.

Best practices
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings need to be unique across the entire docs, so I wonder if it makes sense to expand this to 'best practices for xxxx'?


In this example, the template displays a message indicating that no Segments are available, with a link to create a new Segment.

Why?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Headings need to be unique, perhaps we should expand this to 'Why provide a uniform message in the absence of results?'?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants