generated from john/python-template
Update documentation for consistency and refactor the code. An unresolved error in testing still exists.
This commit is contained in:
@@ -27,7 +27,7 @@ This page captures a SysML v1.6-style requirements baseline for the production s
|
||||
| REQ-10 | Design Constraint | Keep schema bootstrap explicit and opt-in; normal startup does not mutate production schema. | high | inspection |
|
||||
| REQ-11 | Design Constraint | Use service-backed persistence for core document and job data. | medium | inspection |
|
||||
| REQ-12 | Design Constraint | Store transcription prompts as individual Markdown artifacts for iterative refinement. | medium | inspection |
|
||||
| REQ-13 | Functional | Allow users to revise transcription text from either original text or a previous revision. | low | test |
|
||||
| REQ-13 | Functional | Allow users to create one optional revision of transcription text derived from the original job transcription. | low | test |
|
||||
|
||||
### Requirement Relationships
|
||||
|
||||
|
||||
@@ -58,6 +58,7 @@ erDiagram
|
||||
* A source can belong to only one job (which contains the original transcription). A source can only belong to one document. A source may have one optional transcription revision.
|
||||
* A job can process one or more sources. A job can belong to only one document.
|
||||
* A revision can belong to only one source. A source may have one optional revision.
|
||||
* 1:1 optionality is enforced by uniqueness on `revision.source_id` (no revision history chain).
|
||||
* `Job.text` stores the original immutable provider transcription.
|
||||
* Revision rows are optional user-authored edits and are derived from the original transcription. Unlike jobs, revision rows can be updated.
|
||||
|
||||
|
||||
+3
-3
@@ -16,7 +16,7 @@ V1 is complete when all of the following are true:
|
||||
|
||||
1. **Functional complete**
|
||||
- Upload, queue, processing, status display, and transcription result inspection work end-to-end.
|
||||
- Optional revision workflow is implemented (create/list/view).
|
||||
- Optional revision workflow is implemented (create/view/update single revision).
|
||||
2. **Data-model complete**
|
||||
- Runtime behavior, persistence, and tests all align to `Document` / `Source` / `Job` / `Revision`.
|
||||
3. **Operational complete**
|
||||
@@ -83,7 +83,7 @@ V1 is complete when all of the following are true:
|
||||
### Tasks
|
||||
1. Update job detail and related UI components:
|
||||
- Display original immutable transcription from `Job.text`.
|
||||
- Display optional revision sourced from `Source.revisions`.
|
||||
- Display optional revision sourced from `Source.revision` (0 or 1).
|
||||
2. Align date fields with new schema naming.
|
||||
3. Preserve clear user messaging when no revisions exist.
|
||||
|
||||
@@ -125,7 +125,7 @@ V1 is complete when all of the following are true:
|
||||
- `Document`, `Source`, `Job`, `Revision` relationships and invariants.
|
||||
2. Rewrite service/integration tests:
|
||||
- Worker success/failure paths using `Job.text` / `Job.error_detail`.
|
||||
- Optional revision creation and lineage behavior.
|
||||
- Optional single-revision creation/update behavior.
|
||||
3. Update UI tests for new job-detail/revision rendering behavior.
|
||||
4. Re-enable strict CI quality gates (lint, type, tests).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user