generated from john/python-template
46 lines
1.7 KiB
Markdown
46 lines
1.7 KiB
Markdown
# 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_detail` and terminal state.
|
|
- [ ] Stale processing recovery verified on restart.
|
|
- [ ] Retry/timeout behavior validated against configured limits.
|
|
|
|
## C) Operational Readiness
|
|
|
|
- [ ] `runbook_v1.md` reviewed and current.
|
|
- [ ] `migration_v1.md` reviewed 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" -q` passes.
|
|
- [ ] Targeted external/provider checks executed (if credentials available).
|
|
- [ ] Release evidence recorded in `release_evidence_v1.md`.
|
|
|
|
## E) Traceability and Documentation
|
|
|
|
- [ ] `requirements_v1.md` aligns with implemented V1 behavior.
|
|
- [ ] `architecture_v1.md`, `schema_v1.md`, and `error_handling_v1.md` are consistent.
|
|
- [ ] `traceability_v1.md` is updated with current implementation and test evidence.
|
|
- [ ] `implementation_plan_v1.md` phase 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.
|