generated from john/python-template
1.7 KiB
1.7 KiB
V1 Release Readiness Checklist
Use this checklist before declaring V1 operationally complete.
A) Functional Readiness
- Upload flow works for supported file types.
- Worker transitions jobs through
queued -> processing -> transcribed|failed. - Job detail displays immutable original transcription from
Job.text. - Revision workflow supports create/update/view/delete for optional single revision.
B) Reliability and Error Handling
- Error categories surface with actionable messages in UI/API pathways.
- Failed jobs persist
error_detailand terminal state. - Stale processing recovery verified on restart.
- Retry/timeout behavior validated against configured limits.
C) Operational Readiness
docs/runbook.mdreviewed and current.docs/migration_v1.mdreviewed and current.- Backup and rollback procedures tested at least once.
- Incident escalation packet template is known to operators.
D) Quality Gates
- Lint/type checks pass.
pytest -m "not external" -qpasses.- Targeted external/provider checks executed (if credentials available).
- Release evidence recorded in
docs/release_evidence_v1.md.
E) Traceability and Documentation
docs/requirements.mdaligns with implemented V1 behavior.docs/architecture.md,docs/schema.md, anddocs/error_handling.mdare consistent.docs/traceability_v1.mdis updated with current implementation and test evidence.docs/ver1/ver1.mdphase status updated with evidence references.- REQ traceability evidence links recorded (tests/runbook/checks).
Release Sign-Off
- Technical sign-off complete.
- Operational sign-off complete.
- V1 completion date recorded.