As an industry user, I want to access a glossary to help understand terminology so that I can use the app confidently

[suhafa]

Description:

Based off the work done in #131, we need to now create the page/UI for Glossary/Guidance component. Refer to the Master Glossary page for definitions.

Additional context: The Guidance Document (PDF) will include a Master Glossary, for the MVP, users may just refer to the Master Glossary instead of a glossary in the app.

We can use the Glossary code from Permit, The Building Permit Hub uses Drawer | Chakra UI and anchored links in CMS Lite for their Help Menu. Here is a link to their repo

Glossary from Permit

Acceptance Criteria:

Given I am anywhere in the BCIERS app When I click on the Help link Then I see a Glossary tile in the Help menu

When I click on the Glossary tile Then it takes me to the Glossary Page Glossary Wireframe

Development Checklist:

• [ ] Checklist item
• [ ] Checklist item
• [ ] Checklist item
• [ ] Meets the DOD

Definition of Ready (Note: If any of these points are not applicable, mark N/A)

• [ ] User story is included
• [ ] User role and type are identified
• [ ] Acceptance criteria are included
• [ ] Wireframes are included (if required)
• [ ] Design / Solution is accepted by Product Owner
• [ ] Dependencies are identified (technical, business, regulatory/policy)
• [ ] Story has been estimated (under 13 pts)

Definition of Done (Note: If any of these points are not applicable, mark N/A)

• [ ] Acceptance criteria are tested by the CI pipeline
• [ ] UI meets accessibility requirements
• [ ] Configuration changes are documented, documentation and designs are updated
• [ ] Passes code peer-review
• [ ] Passes QA of Acceptance Criteria with verification in Dev and Test
• [ ] Ticket is ready to be merged to main branch
• [ ] Can be demoed in Sprint Review
• [ ] Bugs or future work cards are identified and created
• [ ] Reviewed and approved by Product Owner

Notes:

-

[rdromey]

To split out the glossary function into a new ticket.

[zoeyli-46]

Split into 2 tickets, help menu is now in #389

One thing to note is, I have glossary as a link within the Help menu, so the only way to get to Glossary is via a help menu. I would advocate prioritizing the Help menu and at least linking the Guidance document in it. But, if we want to just implement Glossary first without help menu for the MVP, then in place of the "Help" link could just be "Glossary" for now. @patriciarussellCAS

Glossary Wireframe <- glossary linked in the help menu <- help menu accessed from the navigation bar. If we don't create the help menu then we can just have Glossary linked here in place of "Help"