generated from john/python-template
Updates to docs. Added new transcription_methodology, revised approach to revisions: 1 revision per document (that can be updated)
This commit is contained in:
+7
-5
@@ -4,7 +4,7 @@ This project is a production application for transcribing and preserving histori
|
||||
|
||||
## Start Here
|
||||
|
||||
Read [architecture.md](architecture.md) first, then review [ver1/ver1.md](ver1/ver1.md).
|
||||
Read [architecture.md](architecture.md) first.
|
||||
|
||||
The architecture page is the primary technical reference and defines:
|
||||
|
||||
@@ -23,7 +23,7 @@ Core capabilities:
|
||||
- asynchronous transcription with visible job status
|
||||
- immutable original transcription persisted with each job (plus provider/model/prompt metadata)
|
||||
- transcription prompt management with one Markdown file per prompt for human refinement over time
|
||||
- optional revision history for user-authored edits (from original text or prior revisions)
|
||||
- optional revisions for user-authored edits of original immutable transcription text
|
||||
- full-text search over accepted transcripts
|
||||
- export of transcript data
|
||||
|
||||
@@ -41,11 +41,13 @@ This operating model keeps deployment and maintenance simple while preserving cl
|
||||
## Documentation Map
|
||||
|
||||
- Architecture and technical design: [architecture.md](architecture.md)
|
||||
- Version 1 implementation plan: [ver1/ver1.md](ver1/ver1.md)
|
||||
- Architecture decision records (ADR index): [adr/README.md](adr/README.md)
|
||||
- Runtime and deployment requirements: [requirements.md](requirements.md)
|
||||
- Error handling policy and operational guidance: [error_handling.md](error_handling.md)
|
||||
- Domain context and transcription policy: [Intent.md](Intent.md)
|
||||
- Domain context and transcription policy: [intent.md](intent.md)
|
||||
- Transcription Methodology: [transcription_methodology.md](transcription_methodology.md)
|
||||
- Data model: [schema.md](schema.md)
|
||||
|
||||
|
||||
|
||||
## Glossary
|
||||
|
||||
|
||||
Reference in New Issue
Block a user