Discovery- Senders have access to writing tools that match their technical abilities

[amazingphilippe]

Discovery - Senders have access to writing tools that match their technical abilities

Description

As a Sender, I need to have access to writing tools that match my technical abilities so that I can craft quality email messages for my audience.

WHY are we building?
Some senders that are not familiar with markdown feel less confident when crafting email templates. Rich templates are a good way to craft structured email messages, and the recipients will ultimately benefit from this change.

WHAT are we building?

• A comparative list of text editing patterns that could be used alongside markdown. Including for each:
  • An a11y overview
  • Technical difficulty to implement
  • Browser compatibility
  • Multilingual compatibilities
  • Extendable/customizable

VALUE created by our solution
When we are ready to tackle this challenge, we are equipped as the Notify team to design and implement a solution for this story.

Acceptance Criteria** (Definition of done)

To be refined through discussion with the team

Given some context, when (X) action occurs, then (Y) outcome is achieved

Participants were able to complete their tasks. For some participants, it wasn't a completely intuitive process, but they were able to complete it.

Some participants expected to format text by using a toolbar or by selecting a word and seeing a styling menu (e.g. Word) For these participants, it wasn't good to learn something in order to complete the task. For them, where to find help wasn't obvious, but they successfully clicked the guide links because they didn't see many other options.

Participants noted that Markdown isn't something they/their colleagues have knowledge about. However if they themselves had technical knowledge, they were happy to find markdown as the formatting language.

If this user story emerged from User Research insights:

• Link research insight back to hypothesis from Epic or Objective in Airtable
• Once change/fix/feature is implemented, mark insight as "resolved" in Airtable
• Once change/fix/feature is implements, link insight to design artifacts (Figma) in Airtable

[amazingphilippe]

• finish AC
• review story with Adrianne and Yael

[yaelberger-commits]

ATAG to give to authors to ensure they are able to create accessible messages

[yaelberger-commits]

Would like this to be a more all-team effort

[jimleroyer]

Potential library candidate (or something similar would be nice):

Online demo: https://simplemde.com/
GitHub repository: https://github.com/sparksuite/simplemde-markdown-editor

[amazingphilippe]

Another candidate: Quill https://quilljs.com/playground/

First impression seems very pleasant to use with a keyboard. It is a rich text editor. I don't know if we can convert to markdown for storage. Probably with unifyjs

[jimleroyer]

Quill seems interesting for its extension mechanism. There are extensions to support markdown, but we should make a listing and evaluate support.

[jimleroyer]

I was browsing Quill's issues for markdown support and there was mention of TipTap (although direct markdown support does not seem possible) and slate (preview here) which would support it. CodeMirror was mentioned too but not sure about that one.

[amazingphilippe]

We tested Lexical with several Fable participants. the testing wasn't perfect, and we need to test again. Perhaps with a more refined version, like GC Forms. @andrewleith has been doing some work in cds-snc/notification-admin#1666

Here are findings to keep in mind before we do another round of testing

[jzbahrai]

We are going to use this card: https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1496

[adriannelee]

Continuing this work on a new card: https://app.zenhub.com/workspaces/notify-planning-614b3ad91bc2030015ed22f5/issues/gh/cds-snc/notification-planning/1496

[amazingphilippe]

Hey team! Please add your planning poker estimate with Zenhub @andrewleith @adriannelee