|
| 1 | +# Data Policy |
| 2 | + |
| 3 | +This repository is a portfolio-grade cash reconciliation automation prototype. It is designed to use synthetic, sample, or anonymized demonstration data only. |
| 4 | + |
| 5 | +## No Real Financial Data |
| 6 | + |
| 7 | +Do not commit any real bank statements, internal ledger extracts, client records, account numbers, transaction histories, vendor payment files, ERP exports, or personally identifiable information to this repository. |
| 8 | + |
| 9 | +This includes, but is not limited to: |
| 10 | + |
| 11 | +- Real bank transaction files |
| 12 | +- Real accounting or ERP ledger exports |
| 13 | +- Client, vendor, employee, or counterparty records |
| 14 | +- Account numbers, routing numbers, payment references, or settlement details |
| 15 | +- Screenshots or reports containing confidential financial information |
| 16 | +- API keys, credentials, tokens, or local model secrets |
| 17 | + |
| 18 | +## Approved Data Types |
| 19 | + |
| 20 | +The following data types are allowed in this repository: |
| 21 | + |
| 22 | +- Synthetic data generated by project scripts |
| 23 | +- Small sample files created only for demonstration purposes |
| 24 | +- Anonymized mock data with no link back to real individuals, companies, accounts, or transactions |
| 25 | +- Documentation explaining the data model, assumptions, and limitations |
| 26 | + |
| 27 | +## Output Files |
| 28 | + |
| 29 | +Generated reconciliation outputs should generally be treated as local artifacts unless they are intentionally included as synthetic demo outputs. |
| 30 | + |
| 31 | +Future generated outputs should be kept out of version control unless they are small, synthetic, and useful for explaining the project. |
| 32 | + |
| 33 | +## Local Development |
| 34 | + |
| 35 | +Use local folders such as the following for private or experimental files: |
| 36 | + |
| 37 | +- `local_data/` |
| 38 | +- `private_data/` |
| 39 | +- `raw_data/` |
| 40 | +- `real_data/` |
| 41 | +- `sensitive_data/` |
| 42 | +- `client_data/` |
| 43 | + |
| 44 | +These folders are ignored by Git and should not be committed. |
| 45 | + |
| 46 | +## AI and LLM Usage |
| 47 | + |
| 48 | +Any AI or LLM assistant used in this project should support analyst review only. It should not be treated as the source of final reconciliation decisions. |
| 49 | + |
| 50 | +The deterministic reconciliation engine remains the control layer. AI-generated explanations, notes, or recommendations should be reviewed by a human analyst before being used in any operational context. |
| 51 | + |
| 52 | +## Public Repository Notice |
| 53 | + |
| 54 | +This repository is public. All committed data should be safe for public viewing. |
| 55 | + |
| 56 | +When in doubt, do not commit the file. |
0 commit comments