bbchops/transcription
1
0
Fork 0
generated from john/python-template
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Creation of MVP.md

Browse Source
This commit is contained in:
Jim Lancaster
2026-06-23 18:56:29 -05:00
parent 187324d903
commit d0626c7653
3 changed files with 201 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/requirements.md
+8 -8
View File
@@ -1,4 +1,4 @@
## Handwriting Transcription System Requirements
## Document Transcription System Requirements
This page captures a SysML v1.6-style requirements baseline for the production system described in [index.md](index.md). The model is represented as concise tables and traceability lists that preserve SysML-style IDs and relationship semantics.
@@ -14,8 +14,8 @@ This page captures a SysML v1.6-style requirements baseline for the production s
| ID | Category | Requirement | Risk | Verify Method |
| --- | --- | --- | --- | --- |
| REQ-0 | System | Provide end-to-end handwriting transcription with persistent, inspectable lifecycle state. | medium | demonstration |
| REQ-1 | Functional | Allow users to upload one or more handwriting images from the web UI. | low | test |
| REQ-0 | System | Provide end-to-end document transcription with persistent, inspectable lifecycle state. | medium | demonstration |
| REQ-1 | Functional | Allow users to upload one or more document images from the web UI. | low | test |
| REQ-2 | Functional | Run each upload through asynchronous processing that returns a transcription or explicit failure. | high | test |
| REQ-3 | Functional | Persist and expose job states: upload, queued, processing, transcribed, failed, completed. | high | inspection |
| REQ-4 | Functional | Persist transcription output, processing history, and failure details. | medium | test |
@@ -39,11 +39,11 @@ This page captures a SysML v1.6-style requirements baseline for the production s
| Element | Type | Doc Reference |
| --- | --- | --- |
| UI | NiceGUI pages | src/handwriting/ui/pages |
| API | FastAPI routes | src/handwriting/api/routes.py |
| GRAPH | Async processing workflow | src/handwriting/services, src/handwriting/ai |
| DBREL | PostgreSQL + SQLModel relational persistence | src/handwriting/db |
| DBDOC | MongoDB document persistence | src/handwriting/db, src/handwriting/services |
| UI | NiceGUI pages | src/transcription/ui/pages |
| API | FastAPI routes | src/transcription/api/routes.py |
| GRAPH | Async processing workflow | src/transcription/services, src/transcription/ai |
| DBREL | PostgreSQL + SQLModel relational persistence | src/transcription/db |
| DBDOC | MongoDB document persistence | src/transcription/db, src/transcription/services |
| OPS | Docker Compose runtime | docker-compose.yml |
| PROMPTS | Transcription prompt artifact library (Markdown files) | .github/prompts, docs |
| TESTS | Pytest verification suite | tests |