@kudusov.takhir/ba-toolkit 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/CHANGELOG.md +125 -0
  2. package/COMMANDS.md +69 -0
  3. package/LICENSE +21 -0
  4. package/README.md +842 -0
  5. package/README.ru.md +846 -0
  6. package/bin/ba-toolkit.js +468 -0
  7. package/package.json +49 -0
  8. package/skills/ac/SKILL.md +88 -0
  9. package/skills/analyze/SKILL.md +126 -0
  10. package/skills/apicontract/SKILL.md +113 -0
  11. package/skills/brief/SKILL.md +120 -0
  12. package/skills/clarify/SKILL.md +96 -0
  13. package/skills/datadict/SKILL.md +98 -0
  14. package/skills/estimate/SKILL.md +124 -0
  15. package/skills/export/SKILL.md +215 -0
  16. package/skills/glossary/SKILL.md +145 -0
  17. package/skills/handoff/SKILL.md +146 -0
  18. package/skills/nfr/SKILL.md +85 -0
  19. package/skills/principles/SKILL.md +182 -0
  20. package/skills/references/closing-message.md +33 -0
  21. package/skills/references/domains/ecommerce.md +209 -0
  22. package/skills/references/domains/fintech.md +180 -0
  23. package/skills/references/domains/healthcare.md +223 -0
  24. package/skills/references/domains/igaming.md +183 -0
  25. package/skills/references/domains/logistics.md +221 -0
  26. package/skills/references/domains/on-demand.md +231 -0
  27. package/skills/references/domains/real-estate.md +241 -0
  28. package/skills/references/domains/saas.md +185 -0
  29. package/skills/references/domains/social-media.md +234 -0
  30. package/skills/references/environment.md +57 -0
  31. package/skills/references/prerequisites.md +191 -0
  32. package/skills/references/templates/README.md +35 -0
  33. package/skills/references/templates/ac-template.md +58 -0
  34. package/skills/references/templates/analyze-template.md +65 -0
  35. package/skills/references/templates/apicontract-template.md +183 -0
  36. package/skills/references/templates/brief-template.md +51 -0
  37. package/skills/references/templates/datadict-template.md +75 -0
  38. package/skills/references/templates/export-template.md +112 -0
  39. package/skills/references/templates/handoff-template.md +102 -0
  40. package/skills/references/templates/nfr-template.md +97 -0
  41. package/skills/references/templates/principles-template.md +118 -0
  42. package/skills/references/templates/research-template.md +99 -0
  43. package/skills/references/templates/risk-template.md +188 -0
  44. package/skills/references/templates/scenarios-template.md +93 -0
  45. package/skills/references/templates/sprint-template.md +158 -0
  46. package/skills/references/templates/srs-template.md +90 -0
  47. package/skills/references/templates/stories-template.md +60 -0
  48. package/skills/references/templates/trace-template.md +59 -0
  49. package/skills/references/templates/usecases-template.md +51 -0
  50. package/skills/references/templates/wireframes-template.md +96 -0
  51. package/skills/research/SKILL.md +136 -0
  52. package/skills/risk/SKILL.md +163 -0
  53. package/skills/scenarios/SKILL.md +113 -0
  54. package/skills/sprint/SKILL.md +174 -0
  55. package/skills/srs/SKILL.md +124 -0
  56. package/skills/stories/SKILL.md +85 -0
  57. package/skills/trace/SKILL.md +85 -0
  58. package/skills/usecases/SKILL.md +91 -0
  59. package/skills/wireframes/SKILL.md +107 -0
@@ -0,0 +1,223 @@
1
+ # Domain Reference: Healthcare / MedTech
2
+
3
+ Domain-specific knowledge for healthcare and medical technology projects: telemedicine platforms, patient portals, EHR/EMR systems, clinic management systems, mental health apps, medical device integrations, pharmacy platforms.
4
+
5
+ ---
6
+
7
+ ## 1. /brief — Project Brief
8
+
9
+ ### Domain-specific interview questions
10
+ - Product type: telemedicine (video consultations), patient portal, EHR/EMR, clinic management, mental health app, pharmacy, medical IoT, health insurance tool?
11
+ - Primary beneficiary: patients, clinicians, clinic administrators, insurance providers?
12
+ - Geographic scope and primary jurisdiction (impacts regulatory requirements: HIPAA / GDPR / FHIR)?
13
+ - Funding model: SaaS subscription (clinic/hospital), direct-to-consumer (D2C), insurance-funded, employer-funded?
14
+ - Integration with existing clinical systems: EHR, LIS (lab), RIS (radiology), billing?
15
+
16
+ ### Typical business goals
17
+ - Reduce patient wait times and administrative overhead.
18
+ - Increase patient retention and adherence to treatment plans.
19
+ - Enable remote care delivery and reduce in-person visit load.
20
+ - Ensure regulatory compliance and pass clinical audits.
21
+ - Provide clinicians with accurate, timely patient data at point of care.
22
+
23
+ ### Typical risks
24
+ - Regulatory non-compliance (HIPAA, GDPR, MDR for medical devices) — fines and loss of licence.
25
+ - Data breach exposing Protected Health Information (PHI) — reputational and legal damage.
26
+ - Clinical error due to incorrect or outdated patient data — patient safety risk.
27
+ - Integration complexity with legacy EHR systems (HL7 v2, FHIR R4).
28
+ - Low clinician adoption due to poor UX or disruption to existing workflows.
29
+
30
+ ---
31
+
32
+ ## 2. /srs — Requirements Specification
33
+
34
+ ### Domain-specific interview questions
35
+ - Roles and actors: patient, doctor/physician, nurse, specialist, pharmacist, lab technician, billing/revenue cycle, admin, insurance coordinator?
36
+ - Appointment types: in-person, video, phone, async messaging?
37
+ - Prescription handling: electronic prescriptions (e-Rx) sent to pharmacy, or printed?
38
+ - Lab results: manual upload, HL7/FHIR integration with LIS, patient-facing results?
39
+ - Billing: self-pay, insurance claims (CMS-1500, UB-04), co-pay collection at visit?
40
+ - Consent management: digital consent forms, consent audit trail, HIPAA authorizations?
41
+ - Multi-clinic or multi-provider support?
42
+
43
+ ### Typical functional areas
44
+ - Patient registration and identity verification.
45
+ - Appointment scheduling (booking, rescheduling, cancellation, reminders).
46
+ - Video / async consultation module.
47
+ - Medical records — SOAP notes, diagnosis codes (ICD-10), problem list, allergies.
48
+ - Prescription management (e-Rx, medication history, refill requests).
49
+ - Lab results — ordering, result delivery to patient and clinician.
50
+ - Billing and insurance claims management.
51
+ - Consent and legal document management.
52
+ - Notifications — appointment reminders, result alerts, prescription ready.
53
+ - Admin dashboard — scheduling, capacity, staff management, reporting.
54
+ - Patient portal — appointments, records, messages, prescriptions.
55
+ - Audit log — all PHI access events logged per HIPAA requirements.
56
+
57
+ ---
58
+
59
+ ## 3. /stories — User Stories
60
+
61
+ ### Domain-specific interview questions
62
+ - Critical patient flows: appointment booking, video consultation, receiving lab results, requesting prescription refill?
63
+ - Critical clinician flows: reviewing patient history before consultation, documenting a visit, ordering labs?
64
+ - Sensitive flows requiring special handling: mental health disclosures, minor patients, proxy (guardian) access?
65
+
66
+ ### Typical epics
67
+ - Patient Registration and Identity (onboarding, identity verification, consent).
68
+ - Appointment Management (booking, reminders, rescheduling).
69
+ - Consultation (video, async, in-person notes).
70
+ - Medical Records (view, update, share).
71
+ - Prescriptions (issue, refill, send to pharmacy).
72
+ - Lab & Diagnostics (order, result notification, patient view).
73
+ - Billing & Payments (insurance claim, co-pay, invoices).
74
+ - Notifications & Alerts (appointment, results, messages).
75
+ - Clinician Workflow (schedule, patient list, documentation).
76
+ - Admin & Reporting (capacity, revenue, compliance reports).
77
+ - Audit & Compliance (access log, consent records).
78
+
79
+ ---
80
+
81
+ ## 4. /usecases — Use Cases
82
+
83
+ ### Domain-specific interview questions
84
+ - Exceptional flows: no-show patient, clinician technical issue during video call, lab result outside critical range (STAT alert)?
85
+ - Emergency flows: how does the system handle a patient reporting a medical emergency during a telemedicine session?
86
+ - Proxy access: can a parent book and view a minor's records? Guardian access for elderly patients?
87
+
88
+ ### Typical exceptional flows
89
+ - Video call technical failure — fallback to phone consultation or reschedule offer.
90
+ - Critical lab value detected — automated STAT alert to clinician, acknowledgement required.
91
+ - Prescription cannot be sent electronically — fallback to printed/faxed prescription.
92
+ - Patient no-show — automatic status update, slot released for rebooking.
93
+ - Insurance claim rejected — notification to billing coordinator with rejection code and resubmission guidance.
94
+ - Clinician cancels same-day — patient notification and priority rebooking offer.
95
+
96
+ ---
97
+
98
+ ## 5. /ac — Acceptance Criteria
99
+
100
+ ### Domain-specific interview questions
101
+ - PHI access controls: role-based access, break-glass emergency access, access logging for HIPAA?
102
+ - Consent requirements: what must be consented before each consultation type? Is re-consent required on policy changes?
103
+ - STAT alerts: what defines a critical lab value? Who must be notified, in what timeframe, with what acknowledgement?
104
+ - Audit trail: what events are logged (who accessed what and when)? How long are logs retained?
105
+ - Prescription validation: formulary check, drug-drug interaction check — automatic or manual?
106
+
107
+ ---
108
+
109
+ ## 6. /nfr — Non-functional Requirements
110
+
111
+ ### Domain-specific interview questions
112
+ - Regulatory jurisdiction: HIPAA (US), GDPR (EU), both, other national regulation?
113
+ - Data residency: must PHI remain in-country (specific cloud region)?
114
+ - Medical device classification (if applicable): FDA Class I / II, CE marking, MDR?
115
+ - Availability expectations: 24/7 for patient-facing portal; business hours only for admin?
116
+
117
+ ### Mandatory NFR categories for Healthcare
118
+ - **Security & Compliance:** HIPAA Business Associate Agreement (BAA) with all vendors storing PHI. End-to-end encryption of PHI in transit (TLS 1.2+) and at rest (AES-256). RBAC with least-privilege. MFA for clinician accounts.
119
+ - **Audit:** All PHI access events logged immutably with user ID, timestamp, record accessed. Minimum retention 6 years (HIPAA). Logs must be tamper-evident.
120
+ - **Availability:** Patient portal and consultation module SLA 99.9%. Admin-only functions may be 99.5%. Planned maintenance during low-usage windows only.
121
+ - **Performance:** Appointment booking page < 1.5s. Video call connection < 5s from acceptance. Lab result page load < 2s.
122
+ - **Data Integrity:** Clinical data must be immutable after clinician sign-off. Corrections tracked as addenda, not overwrites.
123
+ - **Interoperability:** HL7 FHIR R4 APIs for EHR integration where applicable. ICD-10 and CPT codes must be validated against official code sets.
124
+ - **Backup & Recovery:** PHI backups daily, retained 30 days. RTO < 4 hours, RPO < 1 hour for clinical data.
125
+ - **Consent:** Digital consent with timestamp, version, and patient signature must be stored for the lifetime of the patient record.
126
+
127
+ ---
128
+
129
+ ## 7. /datadict — Data Dictionary
130
+
131
+ ### Domain-specific interview questions
132
+ - Patient identity: how is identity verified at registration (government ID, insurance card, email only)?
133
+ - Medical record model: SOAP notes (Subjective, Objective, Assessment, Plan)? Problem-oriented? Free text?
134
+ - Diagnosis coding: ICD-10-CM (clinical), ICD-10-PCS (procedures), or both?
135
+ - Multi-provider: does a patient record belong to one clinic or is it portable across providers on the platform?
136
+ - Soft delete: are patient records soft-deleted (retention required by law)?
137
+
138
+ ### Mandatory entities for Healthcare
139
+ - **Patient** — demographic: name, DOB, gender, contact, insurance, emergency contact. PHI-flagged.
140
+ - **Clinician** — physician, nurse, specialist: NPI number, credentials, specialties, licence state.
141
+ - **Appointment** — type, status (scheduled → confirmed → completed / cancelled / no-show), provider, patient, slot.
142
+ - **ConsultationNote** — SOAP or structured note: subjective, objective, assessment, plan, author, signed timestamp.
143
+ - **Diagnosis** — ICD-10 code, description, onset date, status (active, resolved), linked to note.
144
+ - **Prescription** — medication name, dosage, frequency, quantity, refills, prescriber, date, e-Rx status.
145
+ - **LabOrder** — test panel ordered, ordering clinician, date, priority (routine / STAT).
146
+ - **LabResult** — test name, value, unit, reference range, abnormal flag, received date, reviewed flag.
147
+ - **MedicationHistory** — current and past medications, source (self-reported, EHR, pharmacy).
148
+ - **Allergy** — substance, reaction type, severity, reported date.
149
+ - **InsurancePlan** — payer, plan name, member ID, group number, copay, deductible.
150
+ - **Claim** — billing claim: CPT codes, ICD-10 codes, amount, payer, status, rejection code.
151
+ - **Consent** — type, version, patient signature, timestamp, expiry.
152
+ - **AuditLog** — user ID, action, resource type, resource ID, timestamp, IP address.
153
+ - **Document** — referral, imaging report, external record: type, upload date, access permissions.
154
+
155
+ ---
156
+
157
+ ## 8. /apicontract — API Contract
158
+
159
+ ### Domain-specific interview questions
160
+ - FHIR: are public FHIR R4 endpoints required (for patient data portability / CMS Interoperability Rule)?
161
+ - Webhooks: real-time lab result delivery to clinician, appointment reminders trigger, claim status update?
162
+ - Third-party: integration with telemedicine video provider (Daily.co, Twilio, Zoom Health), e-Rx network (Surescripts), pharmacy?
163
+
164
+ ### Typical endpoint groups
165
+ - **Patients** — create, search, get profile, update demographics, get insurance.
166
+ - **Appointments** — list availability, book, confirm, cancel, reschedule, get details.
167
+ - **Consultations** — start session (video URL), create note, sign note, get notes.
168
+ - **Prescriptions** — create, send to pharmacy, refill request, history.
169
+ - **Lab Orders & Results** — create order, receive result (webhook), get results, acknowledge critical.
170
+ - **Billing** — create claim, get claim status, process co-pay.
171
+ - **Audit** — query audit log (admin only).
172
+ - **Consent** — get latest consent version, record patient consent, get consent history.
173
+ - **FHIR Resources** _(if applicable)_ — Patient, Appointment, Observation, MedicationRequest, DiagnosticReport (R4-compliant).
174
+
175
+ ---
176
+
177
+ ## 9. /wireframes — Wireframe Descriptions
178
+
179
+ ### Domain-specific interview questions
180
+ - Key clinician screens: schedule view, patient chart, note editor, lab order and result view?
181
+ - Key patient screens: appointment booking, health summary, prescription refill, lab result view?
182
+ - Separate apps or unified platform for patient vs. clinician?
183
+ - Video consultation embedded in platform or external link?
184
+
185
+ ### Typical screens
186
+ - **Patient Portal — Home** — upcoming appointments, recent results, messages, quick book.
187
+ - **Appointment Booking** — clinician search, availability calendar, type selection, confirmation.
188
+ - **Consultation Screen** — video panel, patient summary sidebar, note editor, prescription action.
189
+ - **Patient Health Summary** — problem list, medications, allergies, recent visits, lab results.
190
+ - **Lab Result View** — result list, trend chart, reference range, abnormal highlight, clinician comment.
191
+ - **Prescription Refill** — current medications, refill request button, pharmacy selection.
192
+ - **Clinician Schedule** — day/week calendar, patient queue, appointment status management.
193
+ - **Clinical Note Editor** — SOAP sections, ICD-10 lookup, CPT code entry, sign button.
194
+ - **Lab Order Form** — panel selection, priority, ordering notes, STAT flag.
195
+ - **Billing Dashboard** _(admin)_ — claims by status, revenue summary, rejection queue, reports.
196
+ - **Audit Log View** _(admin)_ — searchable log table, export for compliance review.
197
+
198
+ ---
199
+
200
+ ## Domain Glossary
201
+
202
+ | Term | Definition |
203
+ |------|-----------|
204
+ | PHI | Protected Health Information — any individually identifiable health data |
205
+ | HIPAA | Health Insurance Portability and Accountability Act (US) |
206
+ | EHR | Electronic Health Record — longitudinal patient record across providers |
207
+ | EMR | Electronic Medical Record — record within a single practice |
208
+ | FHIR | Fast Healthcare Interoperability Resources — HL7 standard for health data exchange |
209
+ | HL7 | Health Level Seven — standard for clinical data messaging |
210
+ | ICD-10 | International Classification of Diseases, 10th Revision — diagnosis codes |
211
+ | CPT | Current Procedural Terminology — procedure and service codes |
212
+ | NPI | National Provider Identifier — unique ID for US healthcare providers |
213
+ | e-Rx | Electronic Prescription — digitally transmitted to pharmacy |
214
+ | PCP | Primary Care Provider |
215
+ | SOAP note | Structured clinical note: Subjective, Objective, Assessment, Plan |
216
+ | STAT | Immediately urgent (from Latin statim) — highest clinical priority |
217
+ | BAA | Business Associate Agreement — HIPAA-required contract with vendors handling PHI |
218
+ | LIS | Laboratory Information System |
219
+ | RIS | Radiology Information System |
220
+ | Telemedicine | Remote delivery of clinical care via video, phone, or messaging |
221
+ | Formulary | List of medications approved by an insurance plan |
222
+ | Co-pay | Fixed patient payment per visit/prescription under insurance plan |
223
+ | Deductible | Amount patient must pay out-of-pocket before insurance covers costs |
@@ -0,0 +1,183 @@
1
+ # Domain Reference: iGaming
2
+
3
+ Domain-specific knowledge for iGaming projects: online slots, sports betting, casino lobbies, operator admin panels, Telegram Mini Apps, promotional mechanics (tournaments, bonuses, wheel of fortune).
4
+
5
+ ---
6
+
7
+ ## 1. /brief — Project Brief
8
+
9
+ ### Domain-specific interview questions
10
+ - Product type: online slot, sports betting, casino lobby, operator admin panel, promo mechanic, Telegram Mini App?
11
+ - Jurisdictions and licenses: MGA (Malta Gaming Authority), Curaçao eGaming, UKGC (UK Gambling Commission), other?
12
+ - Competitive products / references in iGaming?
13
+ - Integrations: game aggregator, payment providers (which ones), KYC/AML service?
14
+
15
+ ### Typical business goals
16
+ - Increase player retention and LTV (Lifetime Value).
17
+ - Enter a new regulated market.
18
+ - Replace legacy operator platform.
19
+ - Grow GGR (Gross Gaming Revenue) through new game mechanics.
20
+ - Increase ARPU (Average Revenue Per User) through promo mechanics.
21
+
22
+ ### Typical risks
23
+ - License revocation or delay.
24
+ - Regulatory changes in the target jurisdiction.
25
+ - Dependency on a third-party game aggregator.
26
+ - Fraud and bonus hunting.
27
+
28
+ ---
29
+
30
+ ## 2. /srs — Requirements Specification
31
+
32
+ ### Domain-specific interview questions
33
+ - Roles: player, operator, administrator, compliance officer, marketing manager, support agent, affiliate?
34
+ - External integrations: payment providers, game aggregator, KYC/AML service, CRM, push notifications, analytics, affiliate tracking?
35
+ - Multi-currency: which currencies, including crypto? Exchange rate handling?
36
+ - Regulatory requirements: responsible gambling, AML (Anti-Money Laundering), data retention per jurisdiction?
37
+ - Business rules: bet limits, wagering requirements, cooldown periods, age verification?
38
+
39
+ ### Typical functional areas
40
+ - Registration and verification (KYC).
41
+ - Deposit and withdrawal.
42
+ - Gameplay (lobby, game launch, bet history).
43
+ - Bonus system (welcome bonus, free spins, cashback, tournaments).
44
+ - Admin panel (player management, reports, settings).
45
+ - Responsible gambling (limits, self-exclusion, Reality Check).
46
+
47
+ ---
48
+
49
+ ## 3. /stories — User Stories
50
+
51
+ ### Domain-specific interview questions
52
+ - Critical user flows: registration, deposit, game session, withdrawal, bonus activation, verification?
53
+ - Edge cases: bonus hunting, multi-accounting, payment timeouts, connection loss during a spin, limit exceeded?
54
+ - Personas: newcomer, casual player, high roller, VIP, affiliate?
55
+
56
+ ### Typical epics
57
+ - Registration and authentication.
58
+ - Payments (deposit, withdrawal).
59
+ - Gameplay.
60
+ - Bonuses and promotions.
61
+ - Profile and settings.
62
+ - Administration.
63
+ - Responsible gambling.
64
+ - Reporting and analytics.
65
+
66
+ ---
67
+
68
+ ## 4. /usecases — Use Cases
69
+
70
+ ### Domain-specific interview questions
71
+ - Critical alternative flows: payment timeout, KYC rejection, connection loss during spin, insufficient balance, account blocking?
72
+ - System actors: payment provider, game aggregator, RNG service (Random Number Generator), KYC provider?
73
+
74
+ ### Typical exceptional flows
75
+ - Payment provider integration failure.
76
+ - Fraud suspicion (unusual betting pattern).
77
+ - Responsible gambling limit exceeded.
78
+ - Account blocked due to AML check.
79
+ - Game aggregator unavailable.
80
+
81
+ ---
82
+
83
+ ## 5. /ac — Acceptance Criteria
84
+
85
+ ### Domain-specific interview questions
86
+ - Business rules for AC: min/max bet, wagering requirements (playthrough multiplier), cooldown periods, withdrawal limits?
87
+ - Boundary values: minimum deposit, maximum bet, session timeout, maximum win?
88
+ - Data precision: currency — 2 decimal places, coefficients — 3 decimal places, RTP (Return to Player) — percentage with 0.01% precision?
89
+
90
+ ---
91
+
92
+ ## 6. /nfr — Non-functional Requirements
93
+
94
+ ### Domain-specific interview questions
95
+ - Target CCU (Concurrent Users) and RPS (Requests Per Second)?
96
+ - RNG: certification required (GLI, eCOGRA, BMM)? Audit?
97
+ - Responsible gambling: limits (deposit, bet, loss, session time), self-exclusion, cooling-off, Reality Check?
98
+ - Data retention: GDPR, jurisdiction-specific requirements?
99
+
100
+ ### Mandatory NFR categories for iGaming
101
+ - **Performance:** spin response time < 200ms, lobby time-to-first-frame < 2s.
102
+ - **Security:** TLS 1.2+, PII (Personally Identifiable Information) encryption, 2FA for admins, SQL injection and XSS protection.
103
+ - **Compliance:** licensing requirements (MGA/UKGC/Curaçao), transaction audit, log retention 5+ years.
104
+ - **Responsible gambling:** self-limitation tools, automatic notifications, forced breaks.
105
+ - **RNG:** certified random number generator, independent audit.
106
+ - **Availability:** SLA 99.95%+ for gameplay.
107
+
108
+ ---
109
+
110
+ ## 7. /datadict — Data Dictionary
111
+
112
+ ### Domain-specific interview questions
113
+ - Which entities require full audit: transactions, bets, sessions, balance changes, admin actions?
114
+ - Multi-currency: amounts in minor units (cents) or major? Store exchange rate at transaction time?
115
+
116
+ ### Mandatory entities for iGaming
117
+ - **User** — player, including KYC status, verification, limits.
118
+ - **Transaction** — financial operations (deposit, withdrawal, bonus, adjustment).
119
+ - **Bet / Wager** — bet: amount, coefficient, result, game session link.
120
+ - **GameSession** — game session: start, end, game, total bets/wins.
121
+ - **Bonus** — bonus: type, status, wagering progress, expiry.
122
+ - **AuditLog** — audit log: action, actor, timestamp, payload.
123
+ - **Game** — game catalog: provider, RTP, volatility, status.
124
+ - **PaymentMethod** — user payment methods.
125
+ - **ResponsibleGamblingSettings** — limits and self-limitation settings.
126
+
127
+ ---
128
+
129
+ ## 8. /apicontract — API Contract
130
+
131
+ ### Domain-specific interview questions
132
+ - Webhook contracts: payment provider callback, game aggregator events (round start/end, balance check), KYC results?
133
+ - WebSocket: real-time balance, game events, tournament leaderboard?
134
+
135
+ ### Typical endpoint groups
136
+ - Auth (registration, login, refresh, logout).
137
+ - Users (profile, KYC, verification, limits).
138
+ - Payments (deposit, withdrawal, transaction history).
139
+ - Games (catalog, launch, history).
140
+ - Bets (placement, history, details).
141
+ - Bonuses (activation, status, cancellation).
142
+ - Admin (player management, reports, settings).
143
+ - Webhooks (payment callbacks, game aggregator events).
144
+
145
+ ---
146
+
147
+ ## 9. /wireframes — Wireframe Descriptions
148
+
149
+ ### Domain-specific interview questions
150
+ - Key screens: lobby, game screen, profile, cashier (deposit/withdrawal), admin panel, bonus section?
151
+ - Specific states: restricted region, pending verification, self-excluded, maintenance?
152
+
153
+ ### Typical screens
154
+ - Lobby (game catalog with filters and search).
155
+ - Game screen (iframe/canvas game + balance overlay).
156
+ - Cashier — deposit (method selection, amount, confirmation).
157
+ - Cashier — withdrawal (method, amount, verification status).
158
+ - Profile (data, KYC, history, responsible gambling settings).
159
+ - Bonuses (active, available, history).
160
+ - Admin panel: dashboard, player management, transactions, reports.
161
+
162
+ ---
163
+
164
+ ## Domain Glossary
165
+
166
+ | Term | Definition |
167
+ |------|-----------|
168
+ | GGR | Gross Gaming Revenue — total bets minus total wins |
169
+ | NGR | Net Gaming Revenue — GGR minus bonuses and adjustments |
170
+ | RTP | Return to Player — percentage returned to players over time |
171
+ | Wagering requirements | Bonus playthrough requirements — how many times the bonus amount must be wagered |
172
+ | KYC | Know Your Customer — identity verification procedure |
173
+ | AML | Anti-Money Laundering — money laundering prevention |
174
+ | MGA | Malta Gaming Authority — Maltese regulator |
175
+ | UKGC | UK Gambling Commission — British regulator |
176
+ | CCU | Concurrent Users — simultaneous users |
177
+ | RNG | Random Number Generator |
178
+ | Responsible gambling | A set of self-limitation tools for players |
179
+ | Cooldown | Mandatory pause between actions |
180
+ | Self-exclusion | Voluntary access block to gambling |
181
+ | Reality Check | Periodic notification about session duration and results |
182
+ | Freebet / Freespin | Free bet / free spin |
183
+ | Game aggregator | Platform aggregating games from multiple providers |
@@ -0,0 +1,221 @@
1
+ # Domain Reference: Logistics / Delivery
2
+
3
+ Domain-specific knowledge for logistics and delivery projects: last-mile delivery platforms, courier management systems, freight and cargo tracking, warehouse management systems (WMS), fleet management, 3PL portals, route optimisation tools.
4
+
5
+ ---
6
+
7
+ ## 1. /brief — Project Brief
8
+
9
+ ### Domain-specific interview questions
10
+ - Service type: last-mile parcel delivery, same-day courier, long-haul freight, food/grocery delivery logistics layer, reverse logistics (returns), 3PL white-label?
11
+ - Ownership model: own fleet, gig/contractor drivers, hybrid?
12
+ - Geographic scope: city-level, national, cross-border?
13
+ - Order origination: e-commerce platform orders, business clients (B2B), or both?
14
+ - Existing integrations: ERP, e-commerce platform (Shopify, Magento), carrier APIs, mapping services?
15
+
16
+ ### Typical business goals
17
+ - Reduce cost-per-delivery through route optimisation and load efficiency.
18
+ - Increase on-time delivery rate and reduce failed delivery rate.
19
+ - Provide end-to-end real-time visibility to customers and dispatchers.
20
+ - Scale operations without proportional headcount growth.
21
+ - Reduce driver idle time and fuel consumption.
22
+
23
+ ### Typical risks
24
+ - Driver safety and liability for contractor fleet.
25
+ - Real-time GPS accuracy and connectivity in dead-zones.
26
+ - Proof-of-delivery disputes — legal and operational risk.
27
+ - Route planning failure during peak demand (e.g., holiday season).
28
+ - Cross-border customs compliance and documentation errors.
29
+
30
+ ---
31
+
32
+ ## 2. /srs — Requirements Specification
33
+
34
+ ### Domain-specific interview questions
35
+ - Actors: customer (end recipient), business client (shipper), dispatcher/operations manager, driver/courier, warehouse operator, admin, customer support?
36
+ - Order creation: via platform UI, API integration (B2B), or both?
37
+ - Route assignment: manual by dispatcher, auto-assigned by algorithm, or driver self-assign?
38
+ - Delivery confirmation: signature, OTP, photo of parcel at door, QR scan?
39
+ - Notifications: customer SMS/email on dispatch, ETA updates, failed delivery; driver push notifications?
40
+ - Returns: return pickup scheduling, reverse logistics workflow?
41
+ - SLA tiers: standard, express, same-day — different pricing and priority rules?
42
+
43
+ ### Typical functional areas
44
+ - Order intake (manual, API, batch import).
45
+ - Order lifecycle management (created → collected → in-transit → delivered / failed).
46
+ - Route planning and optimisation.
47
+ - Driver / courier management (profiles, shifts, capacity, vehicle).
48
+ - Real-time GPS tracking and ETA calculation.
49
+ - Proof of Delivery (POD) capture: photo, signature, OTP.
50
+ - Customer notifications and self-service tracking page.
51
+ - Dispatcher dashboard (live map, order queue, exceptions).
52
+ - Returns and reverse logistics.
53
+ - Warehouse / hub management (inbound, sorting, outbound).
54
+ - B2B client portal (order submission, bulk upload, reporting, invoicing).
55
+ - Reporting and analytics (delivery performance, SLA adherence, driver KPIs).
56
+
57
+ ---
58
+
59
+ ## 3. /stories — User Stories
60
+
61
+ ### Domain-specific interview questions
62
+ - Driver app flows: receive assignment, navigate to pickup, confirm pickup, navigate to delivery, capture POD, report exception?
63
+ - Dispatcher flows: assign unassigned orders, monitor live map, handle failed delivery, re-route driver?
64
+ - Customer flows: track parcel, reschedule delivery, provide safe-place instructions, view POD?
65
+
66
+ ### Typical epics
67
+ - Order Creation and Management.
68
+ - Route Planning and Optimisation.
69
+ - Driver Mobile App (pickup, delivery, POD).
70
+ - Real-time Tracking (dispatcher and customer).
71
+ - Proof of Delivery.
72
+ - Failed Delivery and Exception Handling.
73
+ - Notifications (customer, driver, dispatcher).
74
+ - Returns and Reverse Logistics.
75
+ - B2B Client Portal.
76
+ - Reporting and Analytics.
77
+ - Fleet and Driver Management.
78
+
79
+ ---
80
+
81
+ ## 4. /usecases — Use Cases
82
+
83
+ ### Domain-specific interview questions
84
+ - Failed delivery scenarios: no answer at door, address not found, parcel damaged, customer refuses delivery?
85
+ - Edge cases: driver app offline, GPS unavailable in building, customer OTP expired?
86
+ - Cross-border: customs hold, import duty unpaid by recipient?
87
+
88
+ ### Typical exceptional flows
89
+ - Driver cannot locate address — dispatcher intervention, customer contact attempt, re-route or return to depot.
90
+ - Recipient not available — leave in safe place (if instructed), leave notice, reschedule, or return to depot after N attempts.
91
+ - Parcel damaged at pickup — photo evidence captured, order flagged, shipper notified, claim initiated.
92
+ - Driver app goes offline — last known GPS position retained, orders cached locally, sync on reconnect.
93
+ - GPS signal lost in building — manual status update by driver, ETA paused.
94
+ - OTP expired — dispatcher can regenerate and resend to customer.
95
+ - Route optimisation service unavailable — fallback to manually ordered stop list.
96
+
97
+ ---
98
+
99
+ ## 5. /ac — Acceptance Criteria
100
+
101
+ ### Domain-specific interview questions
102
+ - ETA accuracy: what tolerance is acceptable? What triggers an ETA recalculation?
103
+ - POD validity: what counts as valid proof — photo only, photo + signature, OTP?
104
+ - Failed delivery retry policy: how many attempts before return to depot? Time between attempts?
105
+ - SLA breach: when is a delivery marked as breached? Who is notified and within what timeframe?
106
+ - Driver tracking update frequency: how often is GPS position sent to the server?
107
+
108
+ ---
109
+
110
+ ## 6. /nfr — Non-functional Requirements
111
+
112
+ ### Domain-specific interview questions
113
+ - Fleet size and concurrent drivers: how many drivers active simultaneously at peak?
114
+ - Tracking update frequency required by customers: every 30 seconds, every minute?
115
+ - Map provider: Google Maps Platform, HERE, Mapbox, or OpenStreetMap?
116
+ - Offline-first driver app requirement: must work without connectivity for N minutes?
117
+ - Data retention for POD and audit: how many months/years?
118
+
119
+ ### Mandatory NFR categories for Logistics
120
+ - **Real-time Performance:** GPS position updates processed within 2s of receipt. ETA recalculations completed within 3s of position update. Customer tracking page reflects driver position within 5s.
121
+ - **Scalability:** Dispatch and tracking infrastructure must handle peak order volume (e.g., holiday season) with ≤10% increase in latency.
122
+ - **Offline Resilience (driver app):** Driver app must queue up to 200 actions (status updates, POD captures) offline and sync automatically on reconnect with no data loss.
123
+ - **Availability:** Order management and dispatch: 99.9% SLA. Driver app backend: 99.95%. Customer tracking page: 99.9%.
124
+ - **Data Integrity:** POD data (photos, signatures, OTP confirmation) is write-once immutable. Delivery status transitions must be logged with actor and timestamp.
125
+ - **Security:** Driver identity verified before shift start. POD photos stored in private object storage, signed URLs for access. Customer PII (address, phone) masked in driver app after delivery completion.
126
+ - **Location Accuracy:** GPS accuracy ≤ 50m for urban routing. Fallback to cell-tower location when GPS unavailable.
127
+ - **Compliance:** Cross-border shipments must include required customs data fields. GDPR-compliant handling of recipient address data.
128
+
129
+ ---
130
+
131
+ ## 7. /datadict — Data Dictionary
132
+
133
+ ### Domain-specific interview questions
134
+ - Order vs. shipment vs. parcel: does one order produce one shipment, or can it be split into multiple parcels?
135
+ - Stop model: is a route a list of stops, and can stops have multiple orders?
136
+ - Driver identity: employee record, contractor profile, or linked to external HR system?
137
+ - Address: geocoded at creation time or on-demand?
138
+
139
+ ### Mandatory entities for Logistics
140
+ - **Order** — delivery request: origin (pickup) address, destination address, parcel details, SLA tier, status lifecycle.
141
+ - **Parcel** — physical item: dimensions, weight, barcode/QR, contents description.
142
+ - **Shipment** — groups one or more orders for dispatch: assigned driver, vehicle, planned route, actual departure/arrival.
143
+ - **Route** — planned sequence of stops: optimisation parameters, total distance, estimated duration.
144
+ - **Stop** — single delivery or pickup point on a route: address, time window, linked orders.
145
+ - **Driver** — profile: name, contact, licence, vehicle assignment, status (available, on-shift, off-duty).
146
+ - **Vehicle** — type, capacity (weight and volume), licence plate, current assignment.
147
+ - **TrackingEvent** — immutable event: type (picked-up, in-transit, delivered, failed), timestamp, GPS coordinates, actor.
148
+ - **ProofOfDelivery** — delivery confirmation: photo URL, signature data, OTP token, recipient name, timestamp.
149
+ - **FailedDelivery** — reason code, attempt number, next action (reschedule, return, safe-place), notes.
150
+ - **Notification** — channel (SMS, email, push), type (dispatch, ETA, delivered), status (sent, delivered, failed).
151
+ - **Hub / Depot** — warehouse or sorting hub: address, capacity, working hours.
152
+ - **BusinessClient** — B2B shipper account: SLA agreement, billing, API credentials.
153
+ - **Invoice** — billing to B2B client: billing period, order count, amount, payment status.
154
+
155
+ ---
156
+
157
+ ## 8. /apicontract — API Contract
158
+
159
+ ### Domain-specific interview questions
160
+ - Public tracking API: unauthenticated customer tracking by tracking number?
161
+ - Webhook needs: delivery status updates to B2B client systems, failed delivery alert to shipper?
162
+ - Driver app API: REST or more efficient protocol (GraphQL, gRPC) for frequent GPS polling?
163
+
164
+ ### Typical endpoint groups
165
+ - **Orders** — create, list, get detail, cancel, update SLA tier.
166
+ - **Tracking** — get current status by tracking number (public, unauthenticated), get full event history.
167
+ - **Routes** — create optimised route, get route detail, update stop sequence.
168
+ - **Driver App** — get assigned route, confirm pickup, update stop status, submit POD, report exception.
169
+ - **GPS** — ingest position update (high-frequency, lightweight endpoint).
170
+ - **Dispatch** — list unassigned orders, assign to driver, reassign, dispatcher override.
171
+ - **Notifications** — trigger manual notification, get notification history.
172
+ - **Returns** — create return request, schedule pickup, get return status.
173
+ - **B2B Client Portal** — submit orders (single/bulk), get order statuses, download invoice, API key management.
174
+ - **Admin** — driver management, vehicle management, hub management, reports.
175
+ - **Webhooks** — delivery status change, failed delivery, POD captured, SLA breach.
176
+
177
+ ---
178
+
179
+ ## 9. /wireframes — Wireframe Descriptions
180
+
181
+ ### Domain-specific interview questions
182
+ - Dispatcher screen: live map as primary view, or table/queue view with map as secondary?
183
+ - Driver app: mobile-native (iOS/Android) or mobile web (PWA)?
184
+ - Customer tracking: standalone tracking page or embedded in shipper's website?
185
+
186
+ ### Typical screens
187
+ - **Dispatcher Dashboard — Live Map** — real-time driver positions, order pins, status legend, exception alerts.
188
+ - **Order Queue** — list of all active orders: status, driver, ETA, SLA indicator, filter/search.
189
+ - **Order Detail (Dispatcher)** — full order timeline, current driver location, contact driver, reassign action.
190
+ - **Route View** — ordered stop list, ETA per stop, map route overlay, capacity utilisation.
191
+ - **Driver App — Active Route** — current stop detail, navigation action (deep link to maps), stop list.
192
+ - **Driver App — Stop Detail** — recipient name, address, instructions, delivery action buttons (delivered, exception).
193
+ - **Driver App — POD Capture** — photo capture, signature pad, OTP input, submit.
194
+ - **Driver App — Exception Report** — reason selector, notes, photo, save and proceed.
195
+ - **Customer Tracking Page** — order status, driver position on map, ETA, delivery instructions input.
196
+ - **B2B Client Portal — Order Submission** — single order form or bulk CSV upload, SLA selector.
197
+ - **B2B Client Portal — Reporting** — delivery performance, SLA adherence, failed deliveries, invoice download.
198
+
199
+ ---
200
+
201
+ ## Domain Glossary
202
+
203
+ | Term | Definition |
204
+ |------|-----------|
205
+ | POD | Proof of Delivery — evidence that delivery was completed (photo, signature, OTP) |
206
+ | Last-mile | Final leg of delivery from depot/hub to recipient's address |
207
+ | ETA | Estimated Time of Arrival |
208
+ | 3PL | Third-Party Logistics — outsourced logistics and fulfillment |
209
+ | AWB | Air Waybill — shipping document for air freight |
210
+ | Manifesto | List of shipments assigned to a vehicle or route for a given trip |
211
+ | Depot | Distribution centre or hub where parcels are sorted and loaded |
212
+ | SLA | Service Level Agreement — contracted delivery timeframe |
213
+ | Dwell time | Time a driver spends at a stop — indicator of stop efficiency |
214
+ | Geocoding | Converting a text address to geographic coordinates (lat/lon) |
215
+ | Geofencing | Triggering an event when a device enters or exits a defined geographic area |
216
+ | Route optimisation | Algorithm to minimise total distance/time for a set of stops |
217
+ | Reverse logistics | Logistics flow from customer back to seller or depot (returns) |
218
+ | Dead zone | Area with no cellular or GPS signal coverage |
219
+ | OTP | One-Time Password — numeric code used to confirm identity at delivery |
220
+ | Capacity | Vehicle load limit (weight in kg, volume in m³) |
221
+ | Safe place | Pre-authorised location where parcel can be left without signature |