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

error_handling.md added

Browse Source
This commit is contained in:
Jim Lancaster
2026-06-25 12:10:49 -05:00
parent 31ef94d4f5
commit 0cc6b0e1eb
5 changed files with 294 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/step2.md
+5 -5
View File
@@ -9,7 +9,7 @@ Implement the MVP prompt artifact system by creating a curated transcription pro
This step primarily satisfies:
- **REQ-12**: prompts stored as individual Markdown artifacts
- MVP Feature 3: prompt-driven verbatim transcription behavior grounded in `docs/Intent.md`
- MVP Feature 3: prompt-driven verbatim transcription behavior grounded in `docs/intent.md`
---
@@ -17,7 +17,7 @@ This step primarily satisfies:
### In scope
1. Create prompt artifact directory and first prompt file.
2. Encode transcription rules from `docs/Intent.md` into a model-facing prompt.
2. Encode transcription rules from `docs/intent.md` into a model-facing prompt.
3. Define stable prompt structure so future revisions are easy to diff/review.
4. Add lightweight tests that validate artifact presence and baseline quality constraints.
5. Update docs/README references so Step 3 can consume prompt file directly.
@@ -150,7 +150,7 @@ In Step 2, ensure docs reflect this and that Step 3 will resolve:
- Preserve meaningful structure and reading order
- No fabricated text
- [ ] **B3. Add Rule Set from `docs/Intent.md`**
- [ ] **B3. Add Rule Set from `docs/intent.md`**
- Misspellings/errors: `[sic]`
- Missing words: `[word]`
- Uncertain readings: `[guess?]`
@@ -237,7 +237,7 @@ In Step 2, ensure docs reflect this and that Step 3 will resolve:
## Done Criteria (quick gate)
- [ ] Canonical prompt exists and is curated for verbatim transcription.
- [ ] Prompt encodes all high-value handling rules from `docs/Intent.md`.
- [ ] Prompt encodes all high-value handling rules from `docs/intent.md`.
- [ ] Prompt tests pass.
- [ ] Full project tests pass with `uv`.
- [ ] Ready for Step 3 provider integration.
@@ -249,7 +249,7 @@ In Step 2, ensure docs reflect this and that Step 3 will resolve:
Step 2 is complete when all are true:
1. `prompts/transcribe_document.md` exists and is committed.
2. Prompt includes all critical handling rules from `docs/Intent.md`.
2. Prompt includes all critical handling rules from `docs/intent.md`.
3. Prompt is structured with stable section headings for future curation.
4. Prompt tests pass under `uv run pytest -q`.
5. Existing tests remain green (total suite still passes).