docs: align analytics with growth capability
This commit is contained in:
@@ -15,7 +15,7 @@ Turn normalized ZarinPal payment facts into trustworthy, merchant-scoped analyti
|
||||
- Merchant API: requests versioned analytics sections and exposes typed results/events.
|
||||
- Dashboard: renders sections independently as they become ready.
|
||||
- Analytics worker: calculates idempotent section results from PostgreSQL and caches approved aggregates in Redis.
|
||||
- Future AI adapter: post-MVP consumer of minimized, approved aggregate facts only.
|
||||
- AI growth analyst: separately approved consumer of minimized, approved aggregate facts only; see ADR 0015 and `GROWTH-ANALYST-SPEC.md`.
|
||||
|
||||
## In scope
|
||||
|
||||
@@ -36,9 +36,11 @@ Turn normalized ZarinPal payment facts into trustworthy, merchant-scoped analyti
|
||||
|
||||
## Out of scope for MVP
|
||||
|
||||
- Holiday or named-event reporting
|
||||
- AI-generated recommendations or free-form LLM analysis
|
||||
- Forecasting, causal claims, or automated campaign execution
|
||||
The exclusions in this section describe the original four-section analytics MVP. The later, separately approved AI growth analyst adds bounded event analytics and forecasting without changing the canonical MVP period or metric contracts.
|
||||
|
||||
- Holiday or named-event reporting inside the original four analytics sections
|
||||
- Unbounded or free-form LLM analysis
|
||||
- Causal claims or automated campaign execution
|
||||
- Arbitrary merchant-created formulas or cross-merchant filters
|
||||
- Real-time streaming payment ingestion owned by this service
|
||||
- Persisting calculated analytics as PostgreSQL business facts
|
||||
@@ -64,7 +66,7 @@ Every section uses a versioned typed contract and has independent `queued`, `cal
|
||||
- Timing percentiles exclude null values and expose sample size and non-null coverage; missing time never becomes zero.
|
||||
- `NoAttempt` markers create zero-attempt sessions and never count as attempts or retries. `InBank` is an observed attempt stage, not proof of rejection.
|
||||
- Every result states the exact Tehran-local half-open period, Jalali label, unit, sample/denominator, dataset snapshot, metric-definition version, and calculation timestamp.
|
||||
- Approved period types are one Tehran-local day, one Saturday–Friday week, one Jalali month, or one Persian season. Holiday/event dimensions do not exist in the MVP contract.
|
||||
- Approved interactive reporting-period types remain one Tehran-local day, one Saturday–Friday week, one Jalali month, or one Persian season. The separately versioned growth-event catalog is evidence for growth reports, not a new interactive reporting-period type.
|
||||
|
||||
## Peer comparison contract
|
||||
|
||||
|
||||
Reference in New Issue
Block a user