The Platform Content team conducted research in 2023, finding that most participants went to the site for information about Engineering/Development or the collaboration cycle and that 1 in 4 respondents still struggle to find the content they’re looking for. The most recent Quarterly Platform Satisfaction survey found that the build, manual testing, and analytics areas had the highest negative feedback regarding documentation.
How might we improve areas like searchability, IA, and depth of content to improve the build experience for VFS engineers?
Hypothesis or Bet
This initiative impact the quality of teams' work by making the most impactful documentation easier to find.
We will know we're done when... ("Definition of Done")
All issues are complete
Known Blockers/Dependencies
NA
Projected Launch Date
By Q2 2025
Launch Checklist
Guidance (delete before posting)
This checklist is intended to be used to help answer, "is my Platform initiative ready for launch?". All of the items in this checklist should be completed, with artifacts linked---or have a brief explanation of why they've been skipped---before launching a given Platforminitiative. All links or explanations can be provided in Required Artifacts sections. The items that can be skipped are marked as such.
Keep in mind the distinction between Product and Initiative --- each Product needs specific supporting documentation, but Initiatives to improve existing Products should reuse existing documentation for that Product. VSP Product Terminology for details.
Is this service / tool / feature...
... tested?
[ ] Usability test (TODO: link) has been performed, to validate that new changes enable users to do what was intended and that these changes don't worsen quality elsewhere. If usability test isn't relevant for this change, document the reason for skipping it.
[ ] ... and issues discovered in usability testing have been addressed.
Note on skipping: metrics that show the impact of before/after can be a substitute for usability testing.
[ ] End-to-end manual QA or UAT is complete, to validate there are no high-severity issues before launching
[ ] (if applicable) New functionality has thorough, automated tests running in CI/CD
[ ] (if applicable) Post to #vsp-service-design for external communication about this change (e.g. customer-facing meetings)
... measurable
[ ] (if applicable) This change has clearly-defined success metrics, with instrumentation of those analytics where possible, or a reason documented for skipping it.
Status
Problem Statement
The Platform Content team conducted research in 2023, finding that most participants went to the site for information about Engineering/Development or the collaboration cycle and that 1 in 4 respondents still struggle to find the content they’re looking for. The most recent Quarterly Platform Satisfaction survey found that the build, manual testing, and analytics areas had the highest negative feedback regarding documentation.
How might we improve areas like searchability, IA, and depth of content to improve the build experience for VFS engineers?
Hypothesis or Bet
This initiative impact the quality of teams' work by making the most impactful documentation easier to find.
We will know we're done when... ("Definition of Done")
All issues are complete
Known Blockers/Dependencies
NA
Projected Launch Date
By Q2 2025
Launch Checklist
Guidance (delete before posting)
This checklist is intended to be used to help answer, "is my Platform initiative ready for launch?". All of the items in this checklist should be completed, with artifacts linked---or have a brief explanation of why they've been skipped---before launching a given Platforminitiative. All links or explanations can be provided in Required Artifacts sections. The items that can be skipped are marked as such.
Keep in mind the distinction between Product and Initiative --- each Product needs specific supporting documentation, but Initiatives to improve existing Products should reuse existing documentation for that Product. VSP Product Terminology for details.
Is this service / tool / feature...
... tested?
... documented?
... measurable
When you're ready to launch...
Required Artifacts
Documentation
PRODUCT_NAME: directory name used for your product documentationTesting
Measurement
TODOs