department-of-veterans-affairs / va.gov-cms

Editor-centered management for Veteran-centered content.
https://prod.cms.va.gov
GNU General Public License v2.0
98 stars 69 forks source link

Draft content spec for updated Service Location paragraph type #13128

Closed davidmpickett closed 1 year ago

davidmpickett commented 1 year ago

Description

AS A Drupal engineer, I WANT a technical design document of the Service Location paragraph type SO THAT there is nothing ambiguous about the implementation requirements.

AS A PO, CMS team member or stakeholder I WANT to see a detailed content spec SO THAT I can review the design before implementation

Example artifact

Acceptance Criteria

davidmpickett commented 1 year ago

It begins https://docs.google.com/spreadsheets/d/1yk3LQQCLspztbXN0E3Jtj2cUcp0LAwJpeYIuysvIPeQ/edit?usp=sharing

davidmpickett commented 1 year ago

These notes are for mostly future reference for @BlakeOrgan and @thejordanwood when we get into the nitty gritty of interface design for Service Locations in future tickets.

Problem 1 - Distinguish Service Location instances

This is an example from Drupal of a VAMC Facility Service with 2 Service Locations.

screencapture-staging-cms-va-gov-node-add-health-care-local-health-service-2023-04-21-15_46_19

^ There should be some better visual indication that these are two distinct Service Locations that can be rearranged. At minimum possibly a header that says "Service Location" for each instance plus the draggable four way arrow icon.

Compare this to the pattern we're using for Q&A sections where each Q&A in the Questions Section is clearly labelled.

screencapture-staging-cms-va-gov-node-add-page-2023-04-21-15_58_35

Problem 2 - No overall help text

Currently when a Content Type uses the Service Location Paragraph Type, there is no help text that comes with to describe the overall Service Location interface, that has to be added per Content Type. For example in VAMC Facility Non-clinical Service this Service Locations section has no help text intro.

screencapture-staging-cms-va-gov-node-add-vha-facility-nonclinical-service-2023-04-21-16_03_19

Whereas VAMC Facility Service has a header and a block of text that introduces it nicely.

screencapture-staging-cms-va-gov-node-add-health-care-local-health-service-2023-04-21-15_46_19

Problem 3 - When fully expanded, it's easy to get lost

screencapture-staging-cms-va-gov-node-add-health-care-local-health-service-2023-04-21-15_47_43

davidmpickett commented 1 year ago

Possible path forward? Create a new Appointments Paragraph Type modeled after this part of the VAMC Facility Health Service:

screencapture-staging-cms-va-gov-node-352-edit-2023-04-21-17_54_33

davidmpickett commented 1 year ago

I think this draft is as good as i can get it with out chatting more with the team

davidmpickett commented 1 year ago

A single field in this Paragraph Type required a whole new section of the mural

VBA Content model_2023-04-21_23-01-19

davidmpickett commented 1 year ago

Meeting recording from Facilities team review https://civicactions.zoom.us/rec/share/wXdNXmzKdlFl2eGo-d4eajLxh0h_3LLR_BXGjggQVZx-5q4urKsLZZQ8vMOIYsNj.aFKRJt2MyJtbpCWo?startTime=1682361146000 Passcode: *j89Kk@C

davidmpickett commented 1 year ago
davidmpickett commented 1 year ago

To iterate on before CMS collab cycle: