jilladams commented 2 years ago

Background

8630 implemented reusable Single Q&A nodes on Resources & Support. In the spirit of COPE (Create once, Publish everywhere), we want to make it easy for other teams building on CMS content to add Q&A nodes to their content.

We will pilot the approach ourselves by:

Documenting the process to add Reusable Q&A to a content type & its template(s)
Verifying the documentation: we will follow the runbook steps to add reusable Single Q&A nodes on:
- Benefit Hubs
- Campaign Landing Pages

The next immediate priority for Q&A is to make them available on Vet Centers. Our documentation can then be used by the Facilities team for that project.

Benefit hubs

https://prod.cms.va.gov/node/add/landing_page Does not currently include Q&A mechanism, new paradigm for presentation on this content type.

Campaign Landing Pages

https://prod.cms.va.gov/node/add/campaign_landing_page Currently includes option to add FAQ as one-off Q&A entry.

Node form screenshots

![Screen Shot 2022-09-23 at 3 43 27 PM](https://user-images.githubusercontent.com/85581471/192066221-7d64efc0-9a7c-403e-9dbb-f83767429da8.png) ![Screen Shot 2022-09-23 at 3 43 50 PM](https://user-images.githubusercontent.com/85581471/192066222-80b1a339-b51e-4c59-8964-8d63cdf6407c.png)

User Story or Problem Statement

As an editor, I want to reuse existing Single Q&A nodes on additional types of content

Affected users and stakeholders

CMS editors of Benefit Hub content (SWC)
CMS editors of Campaign Landing Page content (VBO editors(?))
CMS editors of Vet Center content (Vet Center editors)
Developers of new Next.js content build, PW teams
Veterans looking for information

Change management triage

The change represented by this user story will:

[ ] Be a site-wide change to appearance or key functionality (such as log-in process)
[X] Be a specific change that requires more than 30 minutes of work by a user to meet a publishing requirement
[ ] Remove a piece of functionality (such as restricting editing functions, or “hardening”)
[ ] Require action by some or all users by a specific deadline
[ ] Change the front end and be highly visible to the public
[ ] Noticeable performance improvements (publishing speed, predictability)

Design principles

Veteran-centered

[x] Single source of truth: Increase reliability and consistency of content on VA.gov by providing a single source of truth.
[ ] Accessible, plain language: Provide guardrails and guidelines to ensure content quality.
[x] Purposely structured content: Ensure Content API can deliver content whose meaning matches its structure.
[ ] Content lifecycle governance: Produce tools, processes and policies to maintain content quality throughout its lifecycle.

Editor-centered

[ ] Purpose-driven: Create an opportunity to involve the editor community in VA’s mission and content strategy goals.
[x] Efficient: Remove distractions and create clear, straightforward paths to get the job done.
[ ] Approachable: Offer friendly guidance over authoritative instruction.
[x] Consistent: Reduce user’s mental load by allowing them to fall back on pattern recognition to complete tasks.
[ ] Empowering: Provide clear information to help editors make decisions about their work.

wesrowe commented 1 year ago

@swirtSJW – the in-line editing issue has complicated the path to introducing reusable Q&As to more content types. Today Jill and I discussed it with Dave, and he supported the idea of removing the in-line editing capability from all content types. Reasons:

It's complicated for the UI/Editor to track edits in different workflow states
There's no way for an Editor to see how edits to a Q&A will impact every context where it's published (as there will be more and more over time)

Dave asked me to run it by Steve, thinking you might have even reached this conclusion before. Are you okay with this path forward?

(Note: I've already written a couple skeletal tickets in this epic for removing in-line editing from R&S and FAQ content types.)

CC @chri5tia @dsasser @jilladams

wesrowe commented 1 year ago

Also @EWashb, please see comment above :)

jilladams commented 1 year ago

Closing loop: https://dsva.slack.com/archives/C52CL1PKQ/p1681236532807649

had a min to ask Swirt about the inline editing in current meeting. He noted: this has come up with Dave before on other products for Facilities, so the topic is familiar and Dave is supportive of disabling it wherever we need to. Sounds like there wasn't a big picture epic to knock it out in all places where it appears.