search

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
96 stars 70 forks source link

PACT wizard: Create eng documentation of implementation #14076

Closed jilladams closed 1 month ago

jilladams commented 1 year ago

Status

[2024-02-20 Fran] Project is paused due to stakeholders wanting to make possible substantiative changes to flow and content.

Description

When we know enough about the PACT Act implementation, we will document any relevant engineering information within the Product docs: https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/pact-act-wizard/engineering/README.md

User story

AS AN engineer I WANT accurate documentation of our products SO THAT I know how to support and maintain them

Engineering notes / background

14072 was original discovery

Implementation tickets are upcoming. We may decide that the implementation is self-documenting. This level of product docs may or may not end up being useful, TBD once we have implementation rolling.

Analytics considerations

If we have added analytics, it may be helpful to document them.

Acceptance criteria

FranECross commented 1 month ago

@randimays I moved this ticket to Ready, in case you can you're able to get started on updating the documentation before you actually do the updates that Jordan is currently reviewing. If not, then we can move this down in prioritization in the ready column and wait until you're able to work on it. Thanks!

randimays commented 1 month ago

PACT Act engineering docs have been published: https://github.com/department-of-veterans-affairs/va.gov-team/tree/master/products/pact-act-wizard/engineering

We don't have any analytics in the app yet; @FranECross do we have that effort underway?

randimays commented 1 month ago

@FranECross @jilladams Docs are in place; please close if you think this is sufficient, or flag here if more is needed.

jilladams commented 1 month ago

I stubbed a very stubby stub to define analytics and assigned to Fran: https://github.com/department-of-veterans-affairs/va.gov-cms/issues/18755.

Docs look great, thank you! Closing.

FranECross commented 1 month ago

@jilladams Thanks for stubbing the analytics ticket? I'll get that started and submitted to the correct folks early next week. cc @randimays