Skip to content

Fidel Docs and consistency when referring to inline icons from UI #96

Description

@taboca

*This feedback is based on a first reading experience, when I found Fidel Docs as part of an interview process; I decided to annotate some points— things I may perceived as ambiguous. Keep in mind that it's my own view and not exactly a problem in the documentation. *

Problem hypothesis

At https://docs.fidel.uk/programs/add-locations I noticed the sudden appearance of icons, ⚡️✅ RT.

I took a bit of time to figure it was probably a reference to an UI (the dashboard).

When I grasped the mental model that was about UI elements, then I was a bit confused about how the icons were not consistent across the text. It's like I would expect all of them to be under a sort of frame, or similar in a way, or to understand they are a kind related to an entity.

From the flash ) to the check to the RT (that by the way looks like text) I used brain power to read. It costed me two blobishrutter; for example

  • "A green check ✅ "
  • "An RT icon"
  • "Program Sync ⚡️"
  • "and the RT will turn green"

Solution UX

It's just that how the text was dealing with these icons seemed a bit random. Just to put in perspective, not saying the following is the right thing:

  • "A green check icon (✅) "
  • "A program sync icon (⚡️)"
  • "A real-time icon (RT)"

By the way, the "RT" was not an icon copied, was a text made of two words. And the others were character encoded icons. Not saying this is wrong; just an observation.

Old data from the feedback preso sent to Eszter earlier

Screen Shot 2020-04-17 at 17 04 20

Screen Shot 2020-04-17 at 17 04 29

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions