@kudusov.takhir/ba-toolkit 3.2.0 → 3.4.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.
@@ -0,0 +1,244 @@
1
+ # Domain Reference: GovTech
2
+
3
+ Domain-specific knowledge for GovTech projects: citizen-facing e-services, permits and licensing, public records and FOIA, tax and benefits, identity and digital wallet, public-procurement (eProcurement), municipal 311 and case management, court and justice systems, voter and elections services.
4
+
5
+ ---
6
+
7
+ ## 1. /brief — Project Brief
8
+
9
+ ### Domain-specific interview questions
10
+ - Service type: citizen-facing portal, permit / licence application, tax filing, benefits eligibility, public records request, 311 / non-emergency service request, court e-filing, vendor / procurement portal, internal case-management for caseworkers?
11
+ - Level of government: national / federal, state / regional, municipal / city, agency-internal?
12
+ - Buyer vs. user: who funds the project (agency, ministry, council) vs. who uses it (citizen, caseworker, vendor)?
13
+ - Identity scheme: national digital ID (e.g. Login.gov, BankID, ItsMe, Aadhaar, eIDAS-recognised national eID), agency-issued credential, or self-asserted account?
14
+ - Languages: which official languages must be supported at launch (often legally mandated)?
15
+ - Procurement vehicle: internal build, prime contractor, framework agreement, GovTech sandbox?
16
+
17
+ ### Typical business goals
18
+ - Reduce time-to-service for citizens (cut processing time from weeks to days/minutes).
19
+ - Reduce cost-per-transaction vs. paper / counter / phone channels.
20
+ - Increase digital channel adoption (move citizens off paper and counters).
21
+ - Reduce caseworker manual effort and processing backlog.
22
+ - Improve service satisfaction (customer-effort score, citizen NPS).
23
+ - Meet legislated digital-service targets (e.g. EU SDG single digital gateway, US 21st Century IDEA Act, UK GDS service standard).
24
+
25
+ ### Typical risks
26
+ - Legacy mainframe / system-of-record integration (COBOL, AS/400, custom XML over SOAP) — slow, expensive, fragile.
27
+ - Procurement and approval cycles measured in years, not months.
28
+ - Heightened press / political scrutiny on launch failures.
29
+ - Accessibility lawsuits (Section 508, WCAG 2.1 AA, EN 301 549) — strict and frequent in the public sector.
30
+ - Data residency and sovereignty: many jurisdictions ban sending citizen data abroad.
31
+ - Equity of access — must work on old phones, low bandwidth, with limited literacy, and on assistive tech.
32
+ - Audit, FOIA, and records-retention obligations apply to every transaction.
33
+
34
+ ---
35
+
36
+ ## 2. /srs — Requirements Specification
37
+
38
+ ### Domain-specific interview questions
39
+ - Roles: citizen, authenticated resident, business representative, caseworker, supervisor, agency administrator, auditor, FOIA officer, third-party API consumer?
40
+ - Identity proofing level: NIST IAL1 (self-asserted), IAL2 (remote identity-proofed), IAL3 (in-person verified)? Authentication assurance level (AAL1/2/3)?
41
+ - Multi-tenancy across agencies: shared platform, agency-isolated, cross-agency single sign-on?
42
+ - Legacy integration: which systems of record (tax, benefits, vital records, land registry, criminal-justice information system) must be read or written, and via which protocols (SOAP, REST, fixed-width batch, EDI)?
43
+ - Compliance: WCAG 2.1 AA / EN 301 549, FedRAMP, FISMA, StateRAMP, ISO 27001, SOC 2, NIST 800-53, sector-specific (CJIS for justice, IRS Pub 1075 for tax, HIPAA for health-related benefits)?
44
+ - Records retention: how long must form submissions, attachments, and audit trails be retained (often 7+ years, sometimes permanently)?
45
+
46
+ ### Typical functional areas
47
+ - Identity proofing and authentication (national digital ID broker).
48
+ - Citizen account / dashboard ("my services", "my correspondence", "my documents").
49
+ - Service catalog and eligibility check.
50
+ - Form intake (multi-step, save-and-resume, prefill from system of record).
51
+ - Document upload and verification.
52
+ - Payment of fees (card, ACH/SEPA, cash voucher at counter or post office).
53
+ - Caseworker queue and case management.
54
+ - Decision letters and outbound correspondence (digital + postal).
55
+ - Public records / FOIA request handling.
56
+ - Audit log and records retention.
57
+ - Reporting for agency leadership and oversight bodies.
58
+ - Notifications (email, SMS, postal letter for unbanked / unconnected citizens).
59
+
60
+ ---
61
+
62
+ ## 3. /stories — User Stories
63
+
64
+ ### Domain-specific interview questions
65
+ - Critical citizen flows: discover service, check eligibility, sign in, fill multi-step form, upload documents, pay fee, receive decision, appeal a decision?
66
+ - Critical caseworker flows: pick up case from queue, request more information, approve / deny, escalate to supervisor, archive?
67
+ - Edge cases: incomplete application after 30 days, expired identity proof, payment refund, lost decision letter, FOIA disclosure with redaction, citizen requests records about themselves?
68
+ - Personas: tech-confident citizen, citizen with low digital literacy, citizen using assistive tech, business representative filing on behalf of a company, caseworker, FOIA officer, auditor.
69
+
70
+ ### Typical epics
71
+ - Sign-in via national digital ID.
72
+ - Citizen dashboard ("my services").
73
+ - Service discovery and eligibility check.
74
+ - Application intake (multi-step form with save-and-resume).
75
+ - Document verification.
76
+ - Fee payment.
77
+ - Caseworker queue and decision-making.
78
+ - Outbound correspondence (digital + postal hybrid).
79
+ - Public records / FOIA.
80
+ - Appeals and grievances.
81
+ - Audit log and records retention.
82
+ - Reporting and oversight.
83
+
84
+ ---
85
+
86
+ ## 4. /usecases — Use Cases
87
+
88
+ ### Domain-specific interview questions
89
+ - Critical alternative flows: identity proof fails, payment declines, citizen abandons mid-form, caseworker requests extra documents, supervisor overrides denial, system-of-record write fails after fee was charged?
90
+ - System actors: national digital ID broker, payment processor, system of record (tax, benefits, vital records), postal hybrid mail provider, geocoder / address validator, document verification service, FOIA workflow system?
91
+
92
+ ### Typical exceptional flows
93
+ - Identity proofing fails (KBA / liveness / document check) — fallback to in-person counter.
94
+ - Citizen has no digital identity — alternative paper or phone channel must remain available.
95
+ - Payment declined — resume application in "fee due" status, do not lose form data.
96
+ - Save-and-resume token expires — citizen must re-authenticate but data is preserved.
97
+ - System of record returns an error after the fee is charged — automatic refund and incident ticket.
98
+ - Caseworker decision is appealed — case re-opens with new SLA clock.
99
+ - Records-retention period elapses — automated archival or destruction per schedule.
100
+ - FOIA disclosure with PII redaction — redaction queue + reviewer sign-off.
101
+
102
+ ---
103
+
104
+ ## 5. /ac — Acceptance Criteria
105
+
106
+ ### Domain-specific interview questions
107
+ - Business rules: eligibility criteria per service, document validity periods, fee schedules, statutory processing time limits, appeal windows?
108
+ - Boundary values: max attachment size, max number of attachments, session timeout (often regulated, e.g. 15-min idle for IRS Pub 1075), form completion deadline?
109
+ - Accessibility AC: WCAG 2.1 AA conformance per page, EN 301 549 conformance for EU public sector, screen-reader announcements for form errors, keyboard-only navigation, plain-language reading level (often grade 6–8 mandated)?
110
+
111
+ ---
112
+
113
+ ## 6. /nfr — Non-functional Requirements
114
+
115
+ ### Domain-specific interview questions
116
+ - Concurrency: peak load on tax-filing day, benefits-application opening day, election registration deadline (10–100× steady state)?
117
+ - Channel parity: any service offered online must remain available via paper / phone — what is the legal requirement?
118
+ - Data residency / sovereignty: must all citizen data stay within national borders? Cloud region restrictions?
119
+ - Disaster recovery: RTO/RPO targets dictated by statute or oversight body?
120
+ - Plain language: maximum reading-grade level (often 6–8) enforced by guideline?
121
+
122
+ ### Mandatory NFR categories for GovTech
123
+ - **Performance:** form pages < 2s on a 3G connection; system-of-record write < 5s (p95); search < 1s.
124
+ - **Scalability:** handle the deadline-day spike (e.g. tax day, FAFSA opening, election registration cutoff) without queueing citizens out.
125
+ - **Availability:** 99.9% during published service hours; planned maintenance restricted to off-hours; status page mandatory for citizen services; outage alerts via the agency comms channel.
126
+ - **Security:** FedRAMP Moderate (US federal) / StateRAMP / ISO 27001 / NIST 800-53 controls; encryption at rest and in transit; audit log of every form submission, decision, and access to PII; multi-factor authentication for caseworkers; sector controls (CJIS, IRS Pub 1075, HIPAA) where applicable.
127
+ - **Privacy:** Privacy Impact Assessment on file; minimal data collection; right of access and right of correction; explicit consent for any secondary use; PII is encrypted and logged on access.
128
+ - **Accessibility:** WCAG 2.1 AA mandatory; EN 301 549 for EU public sector; Section 508 conformance for US federal; tested with assistive tech (NVDA, JAWS, VoiceOver, Dragon).
129
+ - **Plain language:** target reading grade 6–8; multi-language coverage of all official languages; avoidance of jargon and acronyms.
130
+ - **Records retention:** retention schedule per record type (often 7+ years; permanent for some categories); legal hold flag freezes deletion; FOIA-ready export.
131
+ - **Data residency:** all citizen data stored in the relevant jurisdiction; cloud region locked.
132
+ - **Backup:** RPO < 15 min for transactional state, RTO < 4 hours; offsite backup; tested DR runbook.
133
+
134
+ ---
135
+
136
+ ## 7. /datadict — Data Dictionary
137
+
138
+ ### Domain-specific interview questions
139
+ - Multi-tenancy by agency: agency_id on every entity?
140
+ - PII categorisation: which fields are SSN / national ID / DOB / address — and how are they protected (encryption, tokenisation, masked in UI)?
141
+ - Records-retention metadata: every record has a retention class, retention start, scheduled disposal date?
142
+ - Audit trail: every read of PII is logged with actor, reason, timestamp?
143
+
144
+ ### Mandatory entities for GovTech
145
+ - **Citizen** — identity-proofed natural person: name, date of birth, national ID (encrypted), verified address.
146
+ - **Account** — login account: link to Citizen, identity assurance level, MFA enrolment, last sign-in.
147
+ - **Service** — service catalog entry: title, agency, eligibility criteria, fee schedule.
148
+ - **Application** — submitted form instance: service, citizen, status, submission timestamp, fee paid.
149
+ - **FormPage** — multi-step form state: application, page, answers (versioned for save-and-resume).
150
+ - **Document** — uploaded attachment: application, type, file hash, virus-scan status, retention class.
151
+ - **Payment** — fee transaction: application, amount, channel (card, ACH/SEPA, voucher), provider reference.
152
+ - **Case** — caseworker workflow item: application, assigned caseworker, status, SLA clock.
153
+ - **Decision** — outcome: case, decision (approve / deny / request more info), reason, decision date, appealable until.
154
+ - **Correspondence** — outbound message: case, channel (digital, postal, both), template, sent_at, delivery status.
155
+ - **Caseworker** — internal staff: agency, role, MFA status, security clearance level if applicable.
156
+ - **AuditLog** — append-only record: actor, action, target, timestamp, IP, reason (mandatory for PII reads).
157
+ - **RecordsHold** — legal hold marker: entity, hold reason, hold date, lifted_at.
158
+ - **FoiaRequest** — public records request: requester, scope, status, redacted disclosure document, decision date.
159
+
160
+ ---
161
+
162
+ ## 8. /apicontract — API Contract
163
+
164
+ ### Domain-specific interview questions
165
+ - Identity broker integration: SAML 2.0 / OIDC against the national digital ID provider — which assurance levels and claims?
166
+ - System-of-record APIs: SOAP / REST / batch — what authentication (mTLS, signed JWT, IP allow-list)?
167
+ - Public APIs for civic-tech developers: open by default vs. registered keys?
168
+ - Webhook outputs for status changes ("application submitted", "decision issued") to other agency systems?
169
+ - Open-data exports (CSV / JSON / GeoJSON) for transparency and oversight?
170
+
171
+ ### Typical endpoint groups
172
+ - Auth (national digital ID broker callback, MFA enrolment, session refresh).
173
+ - Citizen profile (read, update verified attributes, consent management).
174
+ - Services (catalog, eligibility check).
175
+ - Applications (start, save, submit, list mine, list mine in progress).
176
+ - Documents (upload, virus-scan status, redact, download).
177
+ - Payments (initiate, callback, refund, receipt).
178
+ - Cases (caseworker queue, assign, decide, escalate).
179
+ - Correspondence (templates, send, status).
180
+ - Audit (read by auditor / oversight role only).
181
+ - FOIA (intake, status, disclosure download).
182
+ - Open data (anonymised statistics, machine-readable).
183
+ - Webhooks (outgoing events to other agency systems).
184
+
185
+ ---
186
+
187
+ ## 9. /wireframes — Wireframe Descriptions
188
+
189
+ ### Domain-specific interview questions
190
+ - Key screens: service discovery, eligibility check, sign-in via national ID, multi-step form with save-and-resume, document upload, fee payment, application status, decision letter view, appeal form, caseworker queue, caseworker decision form?
191
+ - Specific states: identity proofing failed, save-and-resume token expired, payment failed, application incomplete after N days, decision pending appeal, redacted FOIA disclosure?
192
+ - Plain-language and accessibility states: large-text mode, high-contrast mode, screen-reader announcements for form errors, language switcher prominently placed?
193
+
194
+ ### Typical screens
195
+ - Service catalog (browse and search by life event: "having a baby", "moving house", "starting a business").
196
+ - Eligibility check (short pre-form to filter ineligible applicants out before identity proofing).
197
+ - Sign-in / identity proofing flow (national ID broker handoff, fallback to in-person).
198
+ - Citizen dashboard (in-progress applications, recent decisions, correspondence inbox).
199
+ - Multi-step form (progress indicator, save-and-resume, plain-language help, inline error messages).
200
+ - Document upload (drag-and-drop, list of accepted types, virus-scan progress).
201
+ - Fee payment (channel choice, receipt).
202
+ - Application status (timeline with statutory SLA clock).
203
+ - Decision letter (digital copy, postal copy mailed, appeal button if applicable).
204
+ - Appeal form (separate flow with its own SLA).
205
+ - Caseworker queue (filter by status, SLA, priority; bulk-assign).
206
+ - Caseworker decision form (read-only application, decision options, reason text, supervisor escalation).
207
+ - Audit screen (read-only, restricted to auditor role).
208
+ - FOIA intake (public form, no sign-in required).
209
+ - Public service status page.
210
+
211
+ ---
212
+
213
+ ## Domain Glossary
214
+
215
+ | Term | Definition |
216
+ |------|-----------|
217
+ | FedRAMP | US federal cloud-security authorisation programme |
218
+ | StateRAMP | US state-level analogue of FedRAMP |
219
+ | FISMA | Federal Information Security Modernization Act (US) |
220
+ | NIST 800-53 | US federal security and privacy controls catalog |
221
+ | CJIS | Criminal Justice Information Services security policy (FBI) |
222
+ | IRS Pub 1075 | US IRS rules for handling federal tax information |
223
+ | eIDAS | EU regulation on electronic identification and trust services |
224
+ | SDG | Single Digital Gateway (EU) — single point of access for cross-border services |
225
+ | GDS | UK Government Digital Service — sets the UK service standard |
226
+ | 21st Century IDEA Act | US law mandating digital service modernisation |
227
+ | EN 301 549 | EU public-sector accessibility standard |
228
+ | WCAG 2.1 AA | Web Content Accessibility Guidelines, level AA |
229
+ | Section 508 | US federal accessibility law for ICT |
230
+ | Login.gov | US federal shared sign-in service |
231
+ | BankID | Nordic national digital ID scheme |
232
+ | ItsMe | Belgian national digital ID |
233
+ | Aadhaar | Indian national digital ID |
234
+ | IAL / AAL | NIST identity-assurance and authentication-assurance levels |
235
+ | KBA | Knowledge-Based Authentication |
236
+ | FOIA | Freedom of Information Act — public records request regime |
237
+ | Privacy Impact Assessment (PIA) | Mandatory privacy review of any system that processes PII |
238
+ | Records retention schedule | Legally mandated table of how long each record class must be kept |
239
+ | Legal hold | Marker that freezes deletion of records subject to litigation or audit |
240
+ | Plain language | Mandated writing standard targeting reading grade 6–8 |
241
+ | Hybrid mail | Postal letter generated digitally and printed by a contracted provider |
242
+ | 311 | Non-emergency municipal service request channel (US) |
243
+ | eFiling | Electronic submission of court documents |
244
+ | eProcurement | Public-sector vendor and bid management |
@@ -30,6 +30,7 @@
30
30
  | 9 | /wireframes | ⬜ Not started | — |
31
31
  | 10 | /scenarios | ⬜ Not started | — |
32
32
  | 11 | /handoff | ⬜ Not started | — |
33
+ | 12 | /implement-plan | ⬜ Not started | — |
33
34
 
34
35
  ## Cross-cutting Tools
35
36
 
@@ -15,7 +15,7 @@ Second step of the BA Toolkit pipeline. Generates an SRS adapted from IEEE 830.
15
15
  0. If `00_principles_*.md` exists in the output directory, load it and apply its conventions (artifact language, ID format, traceability requirements, Definition of Ready, quality gate threshold).
16
16
  1. Read `01_brief_*.md` from the output directory. If missing, warn and suggest running `/brief`.
17
17
  2. Extract: slug, domain, business goals, functionality, stakeholders, constraints, glossary.
18
- 3. If a matching `references/domains/{domain}.md` file exists (currently: `saas`, `fintech`, `ecommerce`, `healthcare`, `logistics`, `on-demand`, `social-media`, `real-estate`, `igaming`), load it and apply its section `2. /srs`.
18
+ 3. If a matching `references/domains/{domain}.md` file exists (currently: `saas`, `fintech`, `ecommerce`, `healthcare`, `logistics`, `on-demand`, `social-media`, `real-estate`, `igaming`, `edtech`, `govtech`, `ai-ml`), load it and apply its section `2. /srs`.
19
19
 
20
20
  ## Environment
21
21