Work With Technical SMEs on Developer Docs Audit

[vbellissimo]

Product Outline

Link

High Level User Story/ies

As a Platform Content team, we need to work with the Platform Engineering work stream to identified SMEs for the content we audited under Developer Docs, so we can collaborate with them to ensure the content is up-to-date and accurate for VFS teams.

Examples of questions to ask SMES about each page:

• (Resolve any launch-blocking issues identified by the Content team)
• Is this info still accurate and up-to-date? Including screenshots, code blocks, etc.
• Is this info still relevant?
• Is there any info missing that should be added?
• Does this page still make sense to live where it is in the IA?
• Does any content need to be retired and/or archived?

Hypothesis or Bet

If we make this change then we expect this to happen.

If we identify SMEs for the content we audited, the Platform Content team and engineers can collaborate to ensure content on the Platform website is as relevant to VFS teams as possible, then:

• we will receive fewer content support requests to update content that is out-of-date
• VFS teams will trust the Platform website as the source of truth
• VFS teams will rely on the Platform website content before going to the Platform Support channel.

OKR

• Ensure Platform website content is up-to-date and accurate
• Fewer content support tickets will be submitted to the Platform Content Team regarding incorrect or irrelevant information

Definition of done

What must be true in order for you to consider this epic complete?

• [ ] Platform Content Team will have mapped SMEs to content we audited for Developer Docs

• As of 2/7/24: 25% mapped

• [ ] Platform Content Team will have collaborated with SMEs to update the content as needed

• As of 2/7/24: 100% checked for Launch Blocking issues

• As of 2/7/24: 18% updates completed

• As of 2/7/24: 7 Waves of work, 2 completed, 5 remaining

Artifacts

• Product outline
• Visual workflow
• Spreadsheet of pages audited (to share with Platform SMEs)
• 171 total documents
• 7 Waves of Iteration

Ideas

• After talking with Lainey Trahan (PM of Platform Product Team), Content product manager reaches out to identified SMES's to align about where their content review falls among their priorities. This will help our team know when to expect to collaborate with them.
• Create tasks for each SME identified and their respective pages within Developer Docs.
• Use our team's existing guidelines on "Working with the Platform Content Team on Bigger Projects"
• It might be nice to post a change announcements/victory when we finish updating an entire section
• How do we utilize the page ownership feature in Confluence during a content review process? Do we change the ownership to the person the tech teams assign as a SME?

[EWashb]

@jknipes can we get an update on this? If there hasn't been work on this, the delivery dates should be updated. Thanks!

[EWashb]

@jknipes are we still on target for the delivery date indicated?

[jknipes]

@EWashb due to reduced capacity on the team and prioritization of initiatives (Code Yellow, Grafana/Loki/Prometheus docs, Pages w/Google Drive links), we will need to extend the delivery date for this milestone. Currently this epic is on the Roadmap for April 24 completion. Updating delivery date here to match.

[EWashb]

I want to pause this initiative until we get more insight into the direction of CODE VA cc: @jknipes