starcoach-hackathon/zarinpal-analytics-frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(spec): approve dashboard planning gate

Browse Source
This commit is contained in:
Amirhossein Khalili
2026-08-20 18:16:52 +03:30
parent ce596b97c4
commit 27fa931b66
2 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/DASHBOARD-SPEC.md
View File

@@ -1,10 +1,10 @@
# Merchant Dashboard Capability Spec
- Status: Draft — not approved for implementation
- Status: Approved product specification — implementation planning authorized; implementation not yet authorized
- Capability: Merchant dashboard
- Last updated: 2026-08-20
Detailed screen-level behavior, representative layouts, content, accessibility, partial-delivery states, and export workflows are specified in [`DASHBOARD-UX-SPEC.md`](DASHBOARD-UX-SPEC.md). Both documents require explicit approval before implementation planning.
Detailed screen-level behavior, representative layouts, content, accessibility, partial-delivery states, and export workflows are specified in [`DASHBOARD-UX-SPEC.md`](DASHBOARD-UX-SPEC.md). Both specifications are approved for implementation planning; implementation still requires approval of the plan, task list, and applicable interface contracts.
## Objective
@@ -103,4 +103,4 @@ Still required before implementation:
- Approved machine-readable analytics, identity, detail, SSE, error, and CSV export interface contracts.
- Product/interface approval for the exact CSV schema, encoding, filename, row cap, delivery, retention, and audit behavior.
- Static adapter fallback/routing behavior under the final Nginx configuration.
- Explicit approval of this capability spec and `DASHBOARD-UX-SPEC.md`.
- Approved Phase 2 implementation plan and Phase 3 task list.

6
docs/DASHBOARD-UX-SPEC.md
View File

@@ -1,6 +1,6 @@
# Dashboard UX Specification
- Status: Draft for product/design approval — implementation is not authorized
- Status: Approved UX specification — implementation planning authorized; implementation is not yet authorized
- Product: ZarinPal Merchant Analytics hackathon dashboard
- Audience: non-technical Persian-speaking merchants, hackathon judges, finance/legal handoff recipients
- Direction: Persian-first RTL
@@ -782,7 +782,7 @@ No implementation work begins until the dashboard capability and this UX specifi
## 21. Remaining approval questions
1. What is the approved CSV interface contract: eligible detail types, exact columns/headers, UTF-8/BOM policy, canonical date fields, filename, row cap, synchronous versus asynchronous delivery, retention, and audit event?
1. Approve or revise the backend draft CSV contract: synchronous delivery, eligible detail types/columns, UTF-8 BOM, ASCII `snake_case` headers, UTC timestamps, filename policy, 100,000-row/50-MiB caps, 60-second deadline, throttling, retention, and audit event.
2. Should CSV preflight be a modal dialog on desktop or an inline disclosure, provided the mobile experience remains a focus-managed full-screen dialog/sheet?
3. Which non-sensitive merchant display field is authoritative for the shell/export preflight when the demo account username and merchant business name differ?
3. Approve the draft `AuthSession.merchant.displayName` field as authoritative for the shell and export preflight when the demo username differs.
4. Is a downloadable chart-data table required in MVP, or is a visible semantic table alternative sufficient while CSV remains limited to authorized detail views?