Skip to content

Commit 56eb3ac

Browse files
Add v3 project structure
1 parent 1d7d43b commit 56eb3ac

12 files changed

Lines changed: 52 additions & 0 deletions

File tree

versions/v3/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Cash Reconciliation Automation v3
2+
3+
v3 is the planned enterprise-readiness upgrade of the cash reconciliation automation project.
4+
5+
The goal is to evolve the current v2 prototype into a more modular, testable, and reviewable reconciliation workflow while keeping the same core design principle:
6+
7+
> deterministic reconciliation logic first, human review for exceptions, and AI only as an assistant layer.
8+
9+
## Planned v3 Direction
10+
11+
v3 will focus on four upgrade areas:
12+
13+
1. **Data contracts and validation**
14+
- Add schema checks for bank statement and internal ledger files.
15+
- Validate required columns, data types, allowed values, and missing fields before reconciliation.
16+
17+
2. **Modular reconciliation engine**
18+
- Refactor standardization, canonicalization, matching, exception classification, and publishing logic into separate modules.
19+
- Preserve v2 output behavior through regression tests.
20+
21+
3. **Candidate matching and review workflow**
22+
- Keep exact and high-confidence deterministic matching first.
23+
- Add a more structured candidate review layer for possible matches and exceptions.
24+
25+
4. **Analyst-facing review interface**
26+
- Build toward a dashboard or workbench that allows users to inspect matched transactions, possible matches, exceptions, and data-quality issues.
27+
28+
## Proposed Structure
29+
30+
```text
31+
versions/v3/
32+
schemas/
33+
contracts/
34+
gx/
35+
src/
36+
adapters/
37+
core/
38+
generation/
39+
matching/
40+
reconciliation/
41+
assistant/
42+
orchestration/
43+
ui/
44+
tests/
45+
```
46+
## Design Principles
47+
48+
- Use synthetic or anonymized demonstration data only.
49+
- Keep reconciliation decisions auditable and explainable.
50+
- Treat AI-generated explanations as support, not final decision logic.
51+
- Separate public presentation assets from code, data, and generated artifacts.
52+
- Preserve existing v2 behavior before adding new functionality.

versions/v3/contracts/gx/.gitkeep

Whitespace-only changes.

versions/v3/schemas/.gitkeep

Whitespace-only changes.

versions/v3/src/adapters/.gitkeep

Whitespace-only changes.

versions/v3/src/assistant/.gitkeep

Whitespace-only changes.

versions/v3/src/core/.gitkeep

Whitespace-only changes.

versions/v3/src/generation/.gitkeep

Whitespace-only changes.

versions/v3/src/matching/.gitkeep

Whitespace-only changes.

versions/v3/src/orchestration/.gitkeep

Whitespace-only changes.

versions/v3/src/reconciliation/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)