Skip to content

Commit eaa8933

Browse files
committed
docs(demo): make sprint 7 walkthrough deterministic and time-boxed
1 parent c8d57ae commit eaa8933

1 file changed

Lines changed: 48 additions & 18 deletions

File tree

docs/DEMO_SCRIPT.md

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,22 @@ Shared local password:
4444

4545
- `ChangeMe123!`
4646

47+
Deterministic case-pick commands:
48+
49+
```bash
50+
docker compose exec -T web python manage.py shell -c "from returns.models import ReturnCase; case = ReturnCase.objects.filter(status='submitted').order_by('id').first(); print(f'OPS_CASE_ID={case.id}'); print(f'OPS_CASE_REF={case.order_reference}')"
51+
docker compose exec -T web python manage.py shell -c "from returns.models import ReturnCase; case = ReturnCase.objects.filter(order_reference='RH-RUNBOOK-SPARSE').first() or ReturnCase.objects.order_by('id').first(); print(f'SHARED_CASE_ID={case.id}'); print(f'SHARED_CASE_REF={case.order_reference}')"
52+
```
53+
54+
Use the printed values throughout the demo:
55+
56+
- use `ops.demo` for the ops queue and ops case-detail steps
57+
- use `admin.demo` for the admin console step
58+
- use `customer.one` for the customer console and shared case-detail step
59+
- use `merchant.one` for the merchant console step
60+
- use `OPS_CASE_ID` for the main operational walkthrough
61+
- use `SHARED_CASE_ID` for the shared case-detail walkthrough
62+
4763
## Demo flow
4864

4965
### 1. Open the public product surface
@@ -73,12 +89,12 @@ Narration:
7389

7490
### 3. Show console dashboards
7591

76-
Log in with seeded users and open:
92+
Log in with these seeded users and open:
7793

78-
- `http://127.0.0.1:8000/console/admin/`
79-
- `http://127.0.0.1:8000/console/ops/`
80-
- `http://127.0.0.1:8000/console/customer/`
81-
- `http://127.0.0.1:8000/console/merchant/`
94+
- `admin.demo` -> `http://127.0.0.1:8000/console/admin/`
95+
- `ops.demo` -> `http://127.0.0.1:8000/console/ops/`
96+
- `customer.one` -> `http://127.0.0.1:8000/console/customer/`
97+
- `merchant.one` -> `http://127.0.0.1:8000/console/merchant/`
8298

8399
Narration:
84100

@@ -90,7 +106,9 @@ Narration:
90106

91107
Open:
92108

93-
- `http://127.0.0.1:8000/ops/`
109+
- log in as `ops.demo`
110+
- open `http://127.0.0.1:8000/ops/`
111+
- locate `OPS_CASE_REF` in the queue
94112

95113
Call out:
96114

@@ -107,9 +125,9 @@ Narration:
107125

108126
### 5. Open an ops case-detail workspace
109127

110-
Open a seeded case from the queue:
128+
Open the deterministic seeded case:
111129

112-
- `http://127.0.0.1:8000/ops/<case_id>/`
130+
- `http://127.0.0.1:8000/ops/<OPS_CASE_ID>/`
113131

114132
Call out:
115133

@@ -129,7 +147,7 @@ Narration:
129147

130148
### 6. Show inline workflow actions
131149

132-
Using an ops or admin account:
150+
Using `ops.demo` on `OPS_CASE_ID`:
133151

134152
- change a case from `submitted` to `in_review`
135153
- raise priority if useful for the demo
@@ -146,7 +164,8 @@ Narration:
146164

147165
Open:
148166

149-
- `http://127.0.0.1:8000/cases/<case_id>/`
167+
- log in as `customer.one`
168+
- open `http://127.0.0.1:8000/cases/<SHARED_CASE_ID>/`
150169

151170
Narration:
152171

@@ -171,17 +190,17 @@ Narration:
171190

172191
### 9. Show the live API surface
173192

174-
Use a browser client or API tool to reference these routes:
193+
Use a browser client or API tool and substitute `OPS_CASE_ID` where needed:
175194

176195
- `POST /api/returns/`
177-
- `GET /api/returns/<case_id>/`
178-
- `PATCH /api/returns/<case_id>/status/`
179-
- `POST /api/returns/<case_id>/notes/`
196+
- `GET /api/returns/<OPS_CASE_ID>/`
197+
- `PATCH /api/returns/<OPS_CASE_ID>/status/`
198+
- `POST /api/returns/<OPS_CASE_ID>/notes/`
180199
- `GET /api/returns/queue/`
181-
- `GET /api/returns/<case_id>/documents/`
182-
- `POST /api/returns/<case_id>/documents/`
183-
- `GET /api/returns/<case_id>/risk/`
184-
- `GET /api/returns/<case_id>/audit-export/`
200+
- `GET /api/returns/<OPS_CASE_ID>/documents/`
201+
- `POST /api/returns/<OPS_CASE_ID>/documents/`
202+
- `GET /api/returns/<OPS_CASE_ID>/risk/`
203+
- `GET /api/returns/<OPS_CASE_ID>/audit-export/`
185204
- `GET /api/analytics/returns/?from=YYYY-MM-DD&to=YYYY-MM-DD`
186205

187206
Narration:
@@ -205,6 +224,17 @@ Narration:
205224
- The project includes repeatable quality checks and a deterministic demo seed.
206225
- The same repository supports product walkthroughs, operational review, and API verification.
207226

227+
## Time box
228+
229+
Suggested pacing for a five to eight minute walkthrough:
230+
231+
- 1 minute: public landing and role entry points
232+
- 1 minute: console dashboards
233+
- 2 minutes: ops queue and ops case-detail workspace
234+
- 1 minute: workflow actions and audit/risk context
235+
- 1 minute: shared case-detail route
236+
- 1 minute: API surface and quality checks
237+
208238
## Optional proof commands
209239

210240
For a more evidence-driven walkthrough, use the current runbook:

0 commit comments

Comments
 (0)