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

Update docs after db restructure

Browse Source
This commit is contained in:
Jim Lancaster
2026-07-01 12:57:13 -05:00
parent b8998025e2
commit 90ba8fefdd
5 changed files with 89 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture.md
+9 -13
View File
@@ -1,4 +1,4 @@
# Architecture
# Architecture
This document describes the production architecture of the personal historical-document transcription system. The system is intentionally optimized for single-user operation, low operational overhead, and clean internal boundaries that support future growth without rewrites.
@@ -17,7 +17,7 @@ The deployed system targets personal use and a corpus of several thousand docume
Current scope includes:
- document upload and metadata capture
- content source upload and metadata capture
- asynchronous transcription jobs
- prompt-library driven transcription behavior, with one Markdown file per prompt
- transcript review and revision history
@@ -131,9 +131,9 @@ Out of scope:
Production transcription flow:
1. A user uploads an image or PDF through the UI or API.
2. The application validates payloads and creates document and job records.
3. The in-process worker dequeues the job and calls the transcription provider.
1. A user uploads one or more content sources through the UI or API.
2. The application validates payloads and creates document, source, and job records.
3. The in-process worker de-queues the job and calls the transcription provider.
4. The application persists transcript output, confidence metadata, and provenance events.
5. Job status transitions from queued to processing to transcribed or failed.
6. The UI and API expose status, revision history, and searchable transcript text.
@@ -142,8 +142,8 @@ Production transcription flow:
System-of-record entities:
- documents and pages
- transcription jobs and status events
- documents and content sources
- transcription jobs, original transcription, and status events
- transcript revisions
- provenance metadata
@@ -250,7 +250,7 @@ Control:
Risk:
- transcription quality varies by document type, handwriting legibility, and image quality
- transcription quality varies by content source type, handwriting legibility, and source quality
Control:
@@ -264,13 +264,9 @@ Control:
- [PostgreSQL documentation](https://www.postgresql.org/docs/)
- [MongoDB documentation](https://www.mongodb.com/docs/)
## Related Pages
## Related Local References
- [System overview](index.md)
- [Version 1 plan](ver1/ver1.md)
- [Version 1 Step 1 plan](ver1/ver1-step1.md)
- [Version 1 Step 1 results](ver1/ver1-step1-results.md)
- [Architecture decision records index](adr/README.md)
## Glossary