the-mindscape-of-bro-tsong/docs/WORKFLOW.md

62 lines
1.4 KiB
Markdown

# Workflow
## 1. Model Extraction Workflow
The project follows this flow:
```text
Original article / representative text
-> source article record
-> source evidence excerpts
-> human-readable model card
-> machine-readable model JSON
-> regression cases
-> selector examples
-> validation report
```
## 2. Development Workflow
For each task:
1. Read `README.md` and `AGENTS.md`.
2. Check `docs/PROJECT_BRIEF.md`.
3. Modify the smallest necessary set of files.
4. Keep JSON and Markdown versions consistent.
5. Run or update validation.
6. Update reports or handoff notes.
7. Do not expand scope without confirmation.
## 3. Model Addition Workflow
When adding a new model:
1. Create a model JSON file in `models/`.
2. Create a human-readable card in `cards/`.
3. Add source article records.
4. Add source evidence excerpts.
5. Add regression cases.
6. Add selector examples if relevant.
7. Run validation.
8. Update documentation.
## 4. Stabilization Workflow
If a model is unstable:
1. Mark `needs_stabilization: true`.
2. Add risks in `stability_profile.main_risks`.
3. Add boundary and misuse regression cases.
4. Do not upgrade to stability level A until tests pass.
## 5. Handoff Workflow
At the end of each work session:
1. Summarize what changed.
2. List created and modified files.
3. Record validation status.
4. Separate assumptions from verified facts.
5. List questions that require product or CCRA judgment.
6. Suggest the smallest useful next tasks.