From ce36c26dab1351a2a912b3ba565fcc103fde8282 Mon Sep 17 00:00:00 2001 From: andersonjeccel <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 5 Jul 2024 09:50:18 -0300 Subject: [PATCH 01/25] [UX] Providing effective user feedback guidelines --- docs/design/feedback.rst | 99 ++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 7 +++ 2 files changed, 106 insertions(+) create mode 100644 docs/design/feedback.rst diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst new file mode 100644 index 00000000..7fd98f99 --- /dev/null +++ b/docs/design/feedback.rst @@ -0,0 +1,99 @@ +Providing effective user feedback +================================= + +When developing features, it is crucial to ensure that users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, we should adopt a proactive approach to inform and guide users. + +Fundamental principles +---------------------- + +The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative user experience. + +- **Visibility**: Keep all functionalities visible, even when there is no data available. +- **Transparency**: Communicate that information is missing. +- **Guidance**: Provide instructions on how to obtain or enable the necessary data. + +Visibility ensures that users are aware of all available functionalities, even when they are not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers users by providing clear paths for action and improvement. Together, these principles transform points of frustration into solutions, helping marketing professionals complete their tasks. + +Practical implementation +------------------------ + +The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the user, anticipating their needs, and guiding them with minimal workload. Every informative message, CTA, or configuration tip serves as a contextual mini-tutorial, educating users about the platform's capabilities while helping them overcome obstacles. + +When encountering situations where data is absent, follow these guidelines: + +- Replace empty areas or zeroed metrics with explanatory messages. For example: + "We don't have any information about the devices used yet. This will happen automatically when users interact with your campaigns." +- Include clear CTAs that guide the user on how to proceed. For example: + "No email activity? Start sending some campaigns to populate this data!" +- If the lack of data is due to incomplete configuration, provide direct guidance: + "It looks like device tracking is not enabled. Go to settings to enable it." +- Help users understand the value of the missing data: + "Device information helps optimize your campaigns for different platforms. Once we have this data, you'll see detailed analytics here." +- Use icons, colors, or visual elements to indicate areas that need attention. + +This approach not only improves immediate usability but also accelerates users' learning curve, leading to more sophisticated use of the platform over time. Users do not feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. + +"No Results" template +--------------------- + +Mautic includes a reusable template for displaying informative messages when no results are available. This template offers a consistent and flexible way to provide user feedback, with options for additional actions. + +Template structure +------------------ + +```twig +{% if tip is defined %} +
+ {{ tip|trans }} + {% if link is defined and (href is defined or onclick is defined) %} + {{link|trans}} + {% endif %} +
+{% endif %} +``` + +Parameters +---------- + +The template accepts the following parameters: + +- **tip** (required): A translation string that contains the main message to be displayed. +- **link** (optional): A translation string for the link/button text. +- **href** (optional): URL for navigation when the link is clicked. +- **onclick** (optional): JavaScript function to be executed when the link is clicked. + +Functionality +------------- + +The template checks if `tip` is defined. If not, nothing will be rendered. If `tip` is present, a `div` with the class `alert alert-info` is created, containing the translated message. If `link` is defined, and at least one of `href` or `onclick` is also present, a link will be added below the main message. The link can be configured to navigate to a new page (`href`) or execute a JavaScript function (`onclick`). + +Usage Example +------------- + +To use this template in your code, you can include it as follows: + +```twig +{{ include('@MauticCore/Helper/no-information.html.twig', { + 'tip': 'mautic.segment.no.results', + 'link': 'mautic.segment.add.new', + 'href': '{{ path('mautic_segment_action', {'objectAction': 'new'}) }}' +}) }} +``` + +In this example, the template will display a message indicating that no segments are available, with a link to create a new segment. + +Why? +---- + +It ensures a uniform presentation of "no results" messages across the platform, providing consistency in the user experience. Its flexibility allows it to be used 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 allows messages to be translated into different languages, making the platform more globally accessible. + +Best Practices +-------------- + +To maximize the effectiveness of this template, it is important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the user understands the current situation. When appropriate, include a link to an action that can help the user resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It is crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the user. Finally, ensure that all strings used are included in the translation files, guaranteeing a consistent experience in all supported languages. + +This approach aligns with modern user experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. By providing relevant information and actions at the exact moment and place where the user needs them, we are creating an interface that not only reacts to user actions but anticipates and meets their needs. + +Clear messages and specific guidance can reduce the number of support tickets related to user confusion or "missing" functionalities. Additionally, by standardizing how we handle empty or inactive states across the platform, we create a more consistent and maintainable codebase. + +It is essential to note that, while we have general guidelines, implementation should be customized for each specific context. A message that works well for empty email metrics might not be appropriate for a campaign report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 83eb42d1..96cf9268 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -51,6 +51,13 @@ There are several ways to support Mautic other than contributing with code. development-environment/setup development-environment/environments +.. toctree:: + :maxdepth: 2 + :caption: Design and UX + :hidden: + + design/feedback + .. toctree:: :maxdepth: 2 :caption: Themes From 60fe81b7390c7311f36756bb47c616dc3d3a0d72 Mon Sep 17 00:00:00 2001 From: andersonjeccel <116097999+andersonjeccel@users.noreply.github.com> Date: Fri, 5 Jul 2024 13:44:09 -0300 Subject: [PATCH 02/25] vale fix --- docs/design/feedback.rst | 80 ++++++++++++++++++++++------------------ 1 file changed, 44 insertions(+), 36 deletions(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 7fd98f99..523a02fc 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -1,56 +1,64 @@ Providing effective user feedback ================================= -When developing features, it is crucial to ensure that users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, we should adopt a proactive approach to inform and guide users. +When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, we should adopt a proactive approach to inform and guide Users. Fundamental principles ---------------------- -The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative user experience. +The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative User experience. - **Visibility**: Keep all functionalities visible, even when there is no data available. - **Transparency**: Communicate that information is missing. - **Guidance**: Provide instructions on how to obtain or enable the necessary data. -Visibility ensures that users are aware of all available functionalities, even when they are not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers users by providing clear paths for action and improvement. Together, these principles transform points of frustration into solutions, helping marketing professionals complete their tasks. +Visibility ensures that Users are aware of all available functionalities, even when they are not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform Points of frustration into solutions, helping marketing professionals complete their tasks. Practical implementation ------------------------ -The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the user, anticipating their needs, and guiding them with minimal workload. Every informative message, CTA, or configuration tip serves as a contextual mini-tutorial, educating users about the platform's capabilities while helping them overcome obstacles. +The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the User, anticipating their needs, and guiding them with minimal workload. Every informative message, call to action (CTA), or configuration tip serves as a contextual mini-tutorial, educating Users about the platform's capabilities while helping them overcome obstacles. When encountering situations where data is absent, follow these guidelines: - Replace empty areas or zeroed metrics with explanatory messages. For example: - "We don't have any information about the devices used yet. This will happen automatically when users interact with your campaigns." -- Include clear CTAs that guide the user on how to proceed. For example: - "No email activity? Start sending some campaigns to populate this data!" + + "We don't have any information about the devices used yet. This will happen automatically when Users interact with your Campaigns." + +- Include clear CTAs that guide the User on how to proceed. For example: + + "No Email activity? Start sending some Campaigns to populate this data!" + - If the lack of data is due to incomplete configuration, provide direct guidance: + "It looks like device tracking is not enabled. Go to settings to enable it." -- Help users understand the value of the missing data: - "Device information helps optimize your campaigns for different platforms. Once we have this data, you'll see detailed analytics here." + +- Help Users understand the value of the missing data: + + "Device information helps optimize your Campaigns for different platforms. Once we have this data, you'll see detailed analytics here." + - Use icons, colors, or visual elements to indicate areas that need attention. -This approach not only improves immediate usability but also accelerates users' learning curve, leading to more sophisticated use of the platform over time. Users do not feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. +This approach not only improves immediate usability but also accelerates Users' learning curve, leading to more sophisticated use of the platform over time. Users do not feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. "No Results" template --------------------- -Mautic includes a reusable template for displaying informative messages when no results are available. This template offers a consistent and flexible way to provide user feedback, with options for additional actions. +Mautic includes a reusable template for displaying informative messages when no results are available. This template offers a consistent and flexible way to provide User feedback, with options for additional actions. -Template structure +Template Structure ------------------ -```twig -{% if tip is defined %} -
- {{ tip|trans }} - {% if link is defined and (href is defined or onclick is defined) %} - {{link|trans}} +.. code-block:: twig + + {% if tip is defined %} +
+ {{ tip|trans }} + {% if link is defined and (href is defined or onclick is defined) %} + {{link|trans}} + {% endif %} +
{% endif %} -
-{% endif %} -``` Parameters ---------- @@ -67,33 +75,33 @@ Functionality The template checks if `tip` is defined. If not, nothing will be rendered. If `tip` is present, a `div` with the class `alert alert-info` is created, containing the translated message. If `link` is defined, and at least one of `href` or `onclick` is also present, a link will be added below the main message. The link can be configured to navigate to a new page (`href`) or execute a JavaScript function (`onclick`). -Usage Example +Usage example ------------- To use this template in your code, you can include it as follows: -```twig -{{ include('@MauticCore/Helper/no-information.html.twig', { - 'tip': 'mautic.segment.no.results', - 'link': 'mautic.segment.add.new', - 'href': '{{ path('mautic_segment_action', {'objectAction': 'new'}) }}' -}) }} -``` +.. code-block:: twig + + {{ include('@MauticCore/Helper/no-information.html.twig', { + 'tip': 'Mautic.segment.no.results', + 'link': 'Mautic.segment.add.new', + 'href': '{{ path('Mautic_segment_action', {'objectAction': 'new'}) }}' + }) }} -In this example, the template will display a message indicating that no segments are available, with a link to create a new segment. +In this example, the template will display a message indicating that no Segments are available, with a link to create a new Segment. Why? ---- -It ensures a uniform presentation of "no results" messages across the platform, providing consistency in the user experience. Its flexibility allows it to be used 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 allows messages to be translated into different languages, making the platform more globally accessible. +It ensures a uniform presentation of "no results" messages across the platform, providing consistency in the User experience. Its flexibility allows it to be used 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 allows messages to be translated into different languages, making the platform more globally accessible. -Best Practices +Best practices -------------- -To maximize the effectiveness of this template, it is important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the user understands the current situation. When appropriate, include a link to an action that can help the user resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It is crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the user. Finally, ensure that all strings used are included in the translation files, guaranteeing a consistent experience in all supported languages. +To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the User. Finally, ensure that all strings used are included in the translation files, guaranteeing a consistent experience in all supported languages. -This approach aligns with modern user experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. By providing relevant information and actions at the exact moment and place where the user needs them, we are creating an interface that not only reacts to user actions but anticipates and meets their needs. +This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. By providing relevant information and actions at the exact moment and place where the User needs them, we are creating an interface that not only reacts to User actions but anticipates and meets their needs. -Clear messages and specific guidance can reduce the number of support tickets related to user confusion or "missing" functionalities. Additionally, by standardizing how we handle empty or inactive states across the platform, we create a more consistent and maintainable codebase. +Clear messages and specific guidance can reduce the number of support tickets related to User confusion or "missing" functionalities. Additionally, by standardizing how we handle empty or inactive states across the platform, we create a more consistent and maintainable codebase. -It is essential to note that, while we have general guidelines, implementation should be customized for each specific context. A message that works well for empty email metrics might not be appropriate for a campaign report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. \ No newline at end of file +It's essential to note that, while we have general guidelines, implementation should be customized for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. From 3734a5f6fd4f8c8acfbf1af237bf8c7d246010b0 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Thu, 25 Jul 2024 14:18:29 +0000 Subject: [PATCH 03/25] fix vale error for warnings and errors --- .gitpod.yml | 3 +++ docs/design/feedback.rst | 39 ++++++++++++++++++++++++--------------- 2 files changed, 27 insertions(+), 15 deletions(-) diff --git a/.gitpod.yml b/.gitpod.yml index fdbbf919..be5de55f 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -13,3 +13,6 @@ vscode: - errata-ai.vale-server - eamodio.gitlens - trond-snekvik.simple-rst + +ports: + - port: 3000 diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 523a02fc..baf62cd3 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -1,16 +1,16 @@ Providing effective user feedback ================================= -When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, we should adopt a proactive approach to inform and guide Users. +When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, adopt a proactive approach to inform and guide Users. Fundamental principles ---------------------- The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative User experience. -- **Visibility**: Keep all functionalities visible, even when there is no data available. -- **Transparency**: Communicate that information is missing. -- **Guidance**: Provide instructions on how to obtain or enable the necessary data. +- **Visibility**: keep all functionalities visible, even when there is no data available. +- **Transparency**: communicate that information is missing. +- **Guidance**: provide instructions on how to obtain or enable the necessary data. Visibility ensures that Users are aware of all available functionalities, even when they are not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform Points of frustration into solutions, helping marketing professionals complete their tasks. @@ -23,7 +23,7 @@ When encountering situations where data is absent, follow these guidelines: - Replace empty areas or zeroed metrics with explanatory messages. For example: - "We don't have any information about the devices used yet. This will happen automatically when Users interact with your Campaigns." + "There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns." - Include clear CTAs that guide the User on how to proceed. For example: @@ -35,18 +35,22 @@ When encountering situations where data is absent, follow these guidelines: - Help Users understand the value of the missing data: - "Device information helps optimize your Campaigns for different platforms. Once we have this data, you'll see detailed analytics here." + "Device information helps optimize your Campaigns for different platforms. Once this data becomes available, see detailed analytics here." - Use icons, colors, or visual elements to indicate areas that need attention. This approach not only improves immediate usability but also accelerates Users' learning curve, leading to more sophisticated use of the platform over time. Users do not feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. +.. vale off + "No Results" template --------------------- +.. vale on + Mautic includes a reusable template for displaying informative messages when no results are available. This template offers a consistent and flexible way to provide User feedback, with options for additional actions. -Template Structure +Template structure ------------------ .. code-block:: twig @@ -65,15 +69,20 @@ Parameters The template accepts the following parameters: -- **tip** (required): A translation string that contains the main message to be displayed. -- **link** (optional): A translation string for the link/button text. -- **href** (optional): URL for navigation when the link is clicked. +- **tip** (required): a translation string that contains the main message to be displayed. +- **link** (optional): a translation string for the link/button text. +- **href** (optional): ``URL`` for navigation when the link is clicked. + +.. vale off + - **onclick** (optional): JavaScript function to be executed when the link is clicked. +.. vale on + Functionality ------------- -The template checks if `tip` is defined. If not, nothing will be rendered. If `tip` is present, a `div` with the class `alert alert-info` is created, containing the translated message. If `link` is defined, and at least one of `href` or `onclick` is also present, a link will be added below the main message. The link can be configured to navigate to a new page (`href`) or execute a JavaScript function (`onclick`). +The template checks if `tip` is defined. If not, nothing renders. If `tip` is present, a `div` with the class `alert alert-info` is created, containing the translated message. If `link` is defined, and at least one of `href` or ``onclick`` is also present, a link is added below the main message. The link can be configured to navigate to a new page ``href`` or execute a JavaScript function ``onclick``. Usage example ------------- @@ -88,7 +97,7 @@ To use this template in your code, you can include it as follows: 'href': '{{ path('Mautic_segment_action', {'objectAction': 'new'}) }}' }) }} -In this example, the template will display a message indicating that no Segments are available, with a link to create a new Segment. +In this example, the template displays a message indicating that no Segments are available, with a link to create a new Segment. Why? ---- @@ -100,8 +109,8 @@ Best practices To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the User. Finally, ensure that all strings used are included in the translation files, guaranteeing a consistent experience in all supported languages. -This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. By providing relevant information and actions at the exact moment and place where the User needs them, we are creating an interface that not only reacts to User actions but anticipates and meets their needs. +This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. Providing relevant information and actions at the exact moment and place where the User needs them creates an interface that not only reacts to User actions but anticipates and meets their needs. -Clear messages and specific guidance can reduce the number of support tickets related to User confusion or "missing" functionalities. Additionally, by standardizing how we handle empty or inactive states across the platform, we create a more consistent and maintainable codebase. +Clear messages and specific guidance reduce the number of support tickets related to User confusion or "missing" functionalities. Additionally, standardizing the handling of empty or inactive states across the platform creates a more consistent and maintainable codebase. -It's essential to note that, while we have general guidelines, implementation should be customized for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. +It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. From 832074326d63a8ba10862006f1a1061f9af6f148 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Thu, 25 Jul 2024 14:44:38 +0000 Subject: [PATCH 04/25] fix vale suggestions --- docs/design/feedback.rst | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index baf62cd3..c06d68ae 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -1,18 +1,22 @@ +.. vale off + Providing effective user feedback ================================= -When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data is not available. Instead of simply hiding tabs or displaying zeroed metrics, for example, adopt a proactive approach to inform and guide Users. +.. vale on + +When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data isn't available. Instead of simply hiding tabs or displaying zeroed metrics, for example, adopt a proactive approach to inform and guide Users. Fundamental principles ---------------------- -The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative User experience. +The principles of visibility, transparency, and guidance Form the foundation of an intuitive and informative User experience. - **Visibility**: keep all functionalities visible, even when there is no data available. - **Transparency**: communicate that information is missing. - **Guidance**: provide instructions on how to obtain or enable the necessary data. -Visibility ensures that Users are aware of all available functionalities, even when they are not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform Points of frustration into solutions, helping marketing professionals complete their tasks. +Visibility ensures that Users are aware of all available functionalities, even when they're not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform Points of frustration into solutions, helping marketing professionals complete their tasks. Practical implementation ------------------------ @@ -31,7 +35,7 @@ When encountering situations where data is absent, follow these guidelines: - If the lack of data is due to incomplete configuration, provide direct guidance: - "It looks like device tracking is not enabled. Go to settings to enable it." + "It looks like device tracking isn't enabled. Go to settings to enable it." - Help Users understand the value of the missing data: @@ -39,7 +43,7 @@ When encountering situations where data is absent, follow these guidelines: - Use icons, colors, or visual elements to indicate areas that need attention. -This approach not only improves immediate usability but also accelerates Users' learning curve, leading to more sophisticated use of the platform over time. Users do not feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. +This approach not only improves immediate usability but also accelerates Users' learning curve, leading to more sophisticated use of the platform over time. Users don't feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. .. vale off @@ -69,9 +73,9 @@ Parameters The template accepts the following parameters: -- **tip** (required): a translation string that contains the main message to be displayed. +- **tip** (required): display a translation string that contains the main message. - **link** (optional): a translation string for the link/button text. -- **href** (optional): ``URL`` for navigation when the link is clicked. +- **href** (optional): use the ``URL`` for navigation when clicking the link. .. vale off @@ -82,7 +86,7 @@ The template accepts the following parameters: Functionality ------------- -The template checks if `tip` is defined. If not, nothing renders. If `tip` is present, a `div` with the class `alert alert-info` is created, containing the translated message. If `link` is defined, and at least one of `href` or ``onclick`` is also present, a link is added below the main message. The link can be configured to navigate to a new page ``href`` or execute a JavaScript function ``onclick``. +The template checks if `tip` is defined. If not, nothing renders. If `tip` is present, create a `div` with the class `alert alert-info` that contains the translated message. If `link` is defined and at least one of `href` or ``onclick`` is present, add a link below the main message. Configure the link to navigate to a new page with ``href`` or execute a JavaScript function with ``onclick``. Usage example ------------- @@ -102,12 +106,12 @@ In this example, the template displays a message indicating that no Segments are Why? ---- -It ensures a uniform presentation of "no results" messages across the platform, providing consistency in the User experience. Its flexibility allows it to be used 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 allows messages to be translated into different languages, making the platform more globally accessible. +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 -------------- -To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the User. Finally, ensure that all strings used are included in the translation files, guaranteeing a consistent experience in all supported languages. +To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the User. Finally, include all strings in the translation files to guarantee a consistent experience in all supported languages. This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. Providing relevant information and actions at the exact moment and place where the User needs them creates an interface that not only reacts to User actions but anticipates and meets their needs. From 86f725e76d5d9b2eeda221c91d01745914040662 Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Thu, 25 Jul 2024 14:49:12 +0000 Subject: [PATCH 05/25] fix vale . --- docs/design/feedback.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index c06d68ae..465d6936 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -73,12 +73,11 @@ Parameters The template accepts the following parameters: +.. vale off + - **tip** (required): display a translation string that contains the main message. - **link** (optional): a translation string for the link/button text. - **href** (optional): use the ``URL`` for navigation when clicking the link. - -.. vale off - - **onclick** (optional): JavaScript function to be executed when the link is clicked. .. vale on From aae12910e6d0cc0a9b90ed42fb8d6b5466d5b8ec Mon Sep 17 00:00:00 2001 From: Favour Chibueze Date: Thu, 25 Jul 2024 14:52:26 +0000 Subject: [PATCH 06/25] fix vale --- docs/design/feedback.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 465d6936..845dfea1 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -21,7 +21,7 @@ Visibility ensures that Users are aware of all available functionalities, even w Practical implementation ------------------------ -The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the User, anticipating their needs, and guiding them with minimal workload. Every informative message, call to action (CTA), or configuration tip serves as a contextual mini-tutorial, educating Users about the platform's capabilities while helping them overcome obstacles. +The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the User, anticipating their needs, and guiding them with minimal workload. Every informative message, call to action, or configuration tip serves as a contextual mini-tutorial, educating Users about the platform's capabilities while helping them overcome obstacles. When encountering situations where data is absent, follow these guidelines: @@ -29,7 +29,7 @@ When encountering situations where data is absent, follow these guidelines: "There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns." -- Include clear CTAs that guide the User on how to proceed. For example: +- Include clear Call To Actions that guide the User on how to proceed. For example: "No Email activity? Start sending some Campaigns to populate this data!" @@ -116,4 +116,4 @@ This approach aligns with modern User experience (UX) design best practices. It Clear messages and specific guidance reduce the number of support tickets related to User confusion or "missing" functionalities. Additionally, standardizing the handling of empty or inactive states across the platform creates a more consistent and maintainable codebase. -It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and CTAs accordingly. +It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and Call to Actions accordingly. From 7172c2b32c5675b848b731c5198a9517e277063d Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:41:56 -0300 Subject: [PATCH 07/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 845dfea1..e5061f1e 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -85,7 +85,7 @@ The template accepts the following parameters: Functionality ------------- -The template checks if `tip` is defined. If not, nothing renders. If `tip` is present, create a `div` with the class `alert alert-info` that contains the translated message. If `link` is defined and at least one of `href` or ``onclick`` is present, add a link below the main message. Configure the link to navigate to a new page with ``href`` or execute a JavaScript function with ``onclick``. +If you've defined ``tip``, a ``div`` with the class ``alert alert-info`` that contains the translated message displays, if not then nothing renders. If you've defined `link` and at least one of ``href`` or ``onclick``, a link below the main message displays. Configure the link to navigate to a new page with ``href`` or execute a JavaScript function with ``onclick``. Usage example ------------- From c81eda848260dc29930bf9e915d1729d91abb8ae Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:44:12 -0300 Subject: [PATCH 08/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index e5061f1e..d5d661d9 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -16,7 +16,7 @@ The principles of visibility, transparency, and guidance Form the foundation of - **Transparency**: communicate that information is missing. - **Guidance**: provide instructions on how to obtain or enable the necessary data. -Visibility ensures that Users are aware of all available functionalities, even when they're not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform Points of frustration into solutions, helping marketing professionals complete their tasks. +Visibility ensures that Users are aware of all available functionalities, even when they're not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform moments of frustration into solutions, helping marketing professionals complete their tasks. Practical implementation ------------------------ From 429dfb8f2f15f121bd9b0aa1c2fa7412d76326dd Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:47:14 -0300 Subject: [PATCH 09/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index d5d661d9..3ce834d8 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -29,7 +29,7 @@ When encountering situations where data is absent, follow these guidelines: "There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns." -- Include clear Call To Actions that guide the User on how to proceed. For example: +- Include clear call to actions that guide the User on how to proceed. For example: "No Email activity? Start sending some Campaigns to populate this data!" From 7d2d0d410b2e79c287afcdacee626b55580096de Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:47:29 -0300 Subject: [PATCH 10/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 3ce834d8..68cee761 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -47,7 +47,7 @@ This approach not only improves immediate usability but also accelerates Users' .. vale off -"No Results" template +'No Results' template --------------------- .. vale on From c1c101c86cf09ba23cf117e1512da1916fe805af Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:47:43 -0300 Subject: [PATCH 11/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 68cee761..e4ae8934 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -105,7 +105,7 @@ In this example, the template displays a message indicating that no Segments are Why? ---- -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. +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 -------------- From 1455119d6046380854a60ffb36d9b010155d08d6 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:47:49 -0300 Subject: [PATCH 12/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index e4ae8934..cab88e2f 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -110,7 +110,7 @@ It ensures a uniform presentation of 'no results' messages across the platform, Best practices -------------- -To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the `tip` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the "no results" situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like "No results found," which may not provide useful information to the User. Finally, include all strings in the translation files to guarantee a consistent experience in all supported languages. +To maximize the effectiveness of this template, it's important to follow some best practices. Always provide a clear and informative message in the ``tip`` parameter, ensuring that the User understands the current situation. When appropriate, include a link to an action that can help the User resolve the 'no results' situation, promoting a more interactive and solution-oriented experience. It's crucial to use specific messages for each context, avoiding generic texts like 'No results found,' which may not provide useful information to the User. Finally, include all strings in the translation files to guarantee a consistent experience in all supported languages. This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. Providing relevant information and actions at the exact moment and place where the User needs them creates an interface that not only reacts to User actions but anticipates and meets their needs. From 289a85726d707009d1205386667ebeb4f6c1bc1e Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:47:56 -0300 Subject: [PATCH 13/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index cab88e2f..e650459e 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -114,6 +114,6 @@ To maximize the effectiveness of this template, it's important to follow some be This approach aligns with modern User experience (UX) design best practices. It incorporates principles of informative design, immediate feedback, and contextual guidance. Providing relevant information and actions at the exact moment and place where the User needs them creates an interface that not only reacts to User actions but anticipates and meets their needs. -Clear messages and specific guidance reduce the number of support tickets related to User confusion or "missing" functionalities. Additionally, standardizing the handling of empty or inactive states across the platform creates a more consistent and maintainable codebase. +Clear messages and specific guidance reduce the number of support tickets related to User confusion or 'missing' functionalities. Additionally, standardizing the handling of empty or inactive states across the platform creates a more consistent and maintainable codebase. It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and Call to Actions accordingly. From d6aa187285e571f145cb8910c1eec302bb360a59 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:48:01 -0300 Subject: [PATCH 14/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index e650459e..7b67d43a 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -116,4 +116,4 @@ This approach aligns with modern User experience (UX) design best practices. It Clear messages and specific guidance reduce the number of support tickets related to User confusion or 'missing' functionalities. Additionally, standardizing the handling of empty or inactive states across the platform creates a more consistent and maintainable codebase. -It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and Call to Actions accordingly. +It's essential to note that, while general guidelines exist, customize implementation for each specific context. A message that works well for empty Email metrics might not be appropriate for a Campaign Report without data. Think critically about the specific context of each implementation and adapt the messages and call to actions accordingly. From 754060ceff93092effbdf507fe8b8ec80088f85a Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:48:35 -0300 Subject: [PATCH 15/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 7b67d43a..8200bf97 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -35,7 +35,7 @@ When encountering situations where data is absent, follow these guidelines: - If the lack of data is due to incomplete configuration, provide direct guidance: - "It looks like device tracking isn't enabled. Go to settings to enable it." + 'It looks like device tracking isn't active. Go to settings to turn it on.' - Help Users understand the value of the missing data: From bd35d256d0eb7975330adc7c1ac5f628b94af8ef Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:50:40 -0300 Subject: [PATCH 16/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 8200bf97..40a99e81 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -10,7 +10,7 @@ When developing features, it's crucial to ensure that Users receive clear feedba Fundamental principles ---------------------- -The principles of visibility, transparency, and guidance Form the foundation of an intuitive and informative User experience. +The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative user experience. - **Visibility**: keep all functionalities visible, even when there is no data available. - **Transparency**: communicate that information is missing. From 87b495ebb83d08f0167fe581334f24c7b0172a5d Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:52:13 -0300 Subject: [PATCH 17/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 40a99e81..6840f189 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -14,7 +14,7 @@ The principles of visibility, transparency, and guidance form the foundation of - **Visibility**: keep all functionalities visible, even when there is no data available. - **Transparency**: communicate that information is missing. -- **Guidance**: provide instructions on how to obtain or enable the necessary data. +- **Guidance**: provide instructions on how to obtain the data or activate the necessary settings. Visibility ensures that Users are aware of all available functionalities, even when they're not active or populated. Transparency builds trust by clearly explaining why certain information might be missing. Guidance empowers Users by providing clear paths for action and improvement. Together, these principles transform moments of frustration into solutions, helping marketing professionals complete their tasks. From bb39bf3af5b79c1284f49c79b5d50df4e9fd7fad Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:52:24 -0300 Subject: [PATCH 18/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 6840f189..4ddd6a9a 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -27,7 +27,7 @@ When encountering situations where data is absent, follow these guidelines: - Replace empty areas or zeroed metrics with explanatory messages. For example: - "There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns." + 'There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns.' - Include clear call to actions that guide the User on how to proceed. For example: From 69451d550b5fab69060c6e81a3ba225c5fd7ee8c Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:52:31 -0300 Subject: [PATCH 19/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 4ddd6a9a..5185d286 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -31,7 +31,7 @@ When encountering situations where data is absent, follow these guidelines: - Include clear call to actions that guide the User on how to proceed. For example: - "No Email activity? Start sending some Campaigns to populate this data!" + 'No Email activity? Start sending some Campaigns to populate this data!' - If the lack of data is due to incomplete configuration, provide direct guidance: From 4b26a6cb418632bad4d0d079d228d70d9bf2811e Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:52:37 -0300 Subject: [PATCH 20/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 5185d286..26dec79e 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -39,7 +39,7 @@ When encountering situations where data is absent, follow these guidelines: - Help Users understand the value of the missing data: - "Device information helps optimize your Campaigns for different platforms. Once this data becomes available, see detailed analytics here." + 'Device information helps optimize your Campaigns for different platforms. Once this data becomes available, see detailed analytics here.' - Use icons, colors, or visual elements to indicate areas that need attention. From b9ec9cd24e13991e57ac01b2960bc63e3c5bd913 Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Thu, 25 Jul 2024 13:52:56 -0300 Subject: [PATCH 21/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 26dec79e..6f3e653f 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -43,7 +43,7 @@ When encountering situations where data is absent, follow these guidelines: - Use icons, colors, or visual elements to indicate areas that need attention. -This approach not only improves immediate usability but also accelerates Users' learning curve, leading to more sophisticated use of the platform over time. Users don't feel "stuck" when encountering areas without data, but are instead motivated to explore and fill those gaps. +This approach not only improves immediate usability but also accelerates the Users' learning curve, leading to more sophisticated use of the platform over time. Users don't feel 'stuck' when encountering areas without data, but are instead motivated to explore and fill those gaps. .. vale off From 6e7a2afb9b0e29c3693a0db20820899e552ce73d Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:31:30 -0300 Subject: [PATCH 22/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 6f3e653f..d223c660 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -5,7 +5,7 @@ Providing effective user feedback .. vale on -When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data isn't available. Instead of simply hiding tabs or displaying zeroed metrics, for example, adopt a proactive approach to inform and guide Users. +When developing features, it's crucial to ensure that Users receive clear feedback and guidance when certain information or data isn't available. Instead of hiding tabs or displaying zeroed metrics, for example, adopt a proactive approach to inform and guide Users. Fundamental principles ---------------------- From bdae60db94a70e4dce45bcb42e5a51f12851cabe Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:31:36 -0300 Subject: [PATCH 23/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index d223c660..e94802ba 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -12,7 +12,7 @@ Fundamental principles The principles of visibility, transparency, and guidance form the foundation of an intuitive and informative user experience. -- **Visibility**: keep all functionalities visible, even when there is no data available. +- **Visibility**: keep all functionalities visible, even when there's no data available. - **Transparency**: communicate that information is missing. - **Guidance**: provide instructions on how to obtain the data or activate the necessary settings. From d99df1460967d57ba44602062084bb1080a943ef Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:31:42 -0300 Subject: [PATCH 24/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index e94802ba..1da18fcd 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -21,7 +21,7 @@ Visibility ensures that Users are aware of all available functionalities, even w Practical implementation ------------------------ -The practical implementation of these guidelines in Mautic goes beyond simply avoiding blank screens. It involves creating a conversation with the User, anticipating their needs, and guiding them with minimal workload. Every informative message, call to action, or configuration tip serves as a contextual mini-tutorial, educating Users about the platform's capabilities while helping them overcome obstacles. +The practical implementation of these guidelines in Mautic goes beyond avoiding blank screens. It involves creating a conversation with the User, anticipating their needs, and guiding them with minimal workload. Every informative message, call to action, or configuration tip serves as a contextual mini-tutorial, educating Users about the platform's capabilities while helping them overcome obstacles. When encountering situations where data is absent, follow these guidelines: From f010768d55a76ebcbf9275e94da195ddfef8458a Mon Sep 17 00:00:00 2001 From: "Anderson, from Dropsolid" <116097999+andersonjeccel@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:31:48 -0300 Subject: [PATCH 25/25] Update docs/design/feedback.rst Co-authored-by: Ruth Cheesley --- docs/design/feedback.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/design/feedback.rst b/docs/design/feedback.rst index 1da18fcd..5d6d3b4b 100644 --- a/docs/design/feedback.rst +++ b/docs/design/feedback.rst @@ -27,7 +27,7 @@ When encountering situations where data is absent, follow these guidelines: - Replace empty areas or zeroed metrics with explanatory messages. For example: - 'There is no information about the devices used yet. This happens automatically when Users interact with your Campaigns.' + 'There's no information about the devices used yet. This happens automatically when Users interact with your Campaigns.' - Include clear call to actions that guide the User on how to proceed. For example: