Transition Documentation: QA

[maortiz-27-80]

User Story or Problem Statement

Our primary objective is to facilitate a smooth transition for the incoming CMS team. To achieve this, we need to document our processes comprehensively. This documentation will serve as a valuable resource for the new team members and contribute to the overall success of the handover.

Overall Process Documentation

• Identify and document end-to-end processes
• Include step-by-step procedures, key milestones, and dependencies
• If applicable, identify and document dependencies on external systems, APIs, or third-party services
• Document the location of critical knowledge repositories, wikis, or documentation sources
• Include information about access permissions and guidelines for updating or maintaining these repositories
• Include an updated list of key contacts within the organization, including team leads, support personnel, and any external contacts relevant to the CMS team's responsibilities
• Document any historical data, insights, or lessons learned from past projects or incidents that may be valuable for the incoming team
• Document the details of the current environment and infrastructure, including server configurations, network architecture, and any specialized hardware or software in use
• Provide information about integration points and how different components of the system interact
• Specify the tools and processes used for monitoring system health
• Provide details on logging practices, log locations, and how to interpret and respond to common log entries
• Outline the process for releasing new features, updates, or patches
• Document versioning practices, release notes, and rollback procedures

Repetitive Processes

• Identify and document repetitive processes that are crucial for daily operations
• Include detailed instructions, best practices, and any relevant tools or resources

Acceptance Criteria

• Document processes in Confluence. Parent page for QA is here.
• Each documented process should be reviewed and approved by the PO, PM, and DM
• The documentation should be clear, concise, and easily understandable by individuals with varying levels of expertise
• Include visual aids, flowcharts, diagrams, and links (external and internal) where applicable to enhance clarity

Team

Please check the team(s) that will do this work.

• CMS Team
• Public Websites
• Facilities
• Accelerated Publishing

cc: @BerniXiongA6 @EWashb @ndouglas

[JunTaoLuo]

Hey @BerniXiongA6 @maortiz-27-80, the document is ready for review so feel free to take a look and let me know if there are details you'd like me to add.

[JunTaoLuo]

@maortiz-27-80 @BerniXiongA6 @michelle-dooley @EWashb the QA doc is ready for a look.

[EWashb]

This is great @JunTaoLuo! Thank you for the thorough write up

[JunTaoLuo]

I'll mark this issue as completed.