tractorjuice--arckit-gemini
2.4 KiB
2.4 KiB
Requirements Guide
Guide Origin: Official | ArcKit Version: [VERSION]
/arckit:requirements produces a single living document covering business, functional, non-functional, integration, and data requirements.
Preparation
| Artefact | Why it matters |
|---|---|
| Stakeholder analysis | Links goals and success criteria |
| Architecture principles | Provides constraints and validation gates |
| Risk register | Captures early compliance and delivery risks |
Command
/arckit:requirements Create requirements for <project>
Output: projects/<id>/ARC-<id>-REQ-v1.0.md.
Auto-versioning: Re-running this command when a document already exists automatically increments the version (minor for refreshed content, major for changed scope) instead of overwriting.
Requirements Matrix
| Type | Prefix | Purpose | Example prompts |
|---|---|---|---|
| Business | BR-### |
Outcomes, KPIs, investment cases | “Reduce payment processing costs by 30%” |
| Functional | FR-### |
User-facing features & flows | “Process card payments and provide receipts” |
| Non-Functional | NFR-<category>-### |
Performance, security, availability, accessibility | “P95 latency < 500ms”, “WCAG 2.2 AA” |
| Integration | INT-### |
Interfaces with external systems | “Integrate with HMRC PAYE API” |
| Data | DR-### |
Entities, retention, PII | “Store audit logs for 7 years encrypted at rest” |
For public sector projects, MoSCoW priorities are automatically assigned.
Review Checklist
- Every requirement includes acceptance criteria and traceability references (stakeholder IDs, risks, principles).
- Conflicts and dependencies are called out (e.g. BR vs NFR tension).
- Regulatory obligations (TCoP, GDPR, WCAG, PCI-DSS) are captured explicitly.
- Integration requirements specify protocols, authentication, and error handling.
- Data requirements include lawful basis and retention aligned with DPIA outputs.
After Generation
- Workshop with stakeholders to confirm priorities and resolve conflicts.
- Feed requirements into
/arckit:sow,/arckit:diagram,/arckit:backlog. - For data mesh architectures, DR-xxx requirements inform
/arckit:data-mesh-contractSLAs and quality rules. - Re-run the command whenever scope changes; commit deltas for audit.
- Pair with
/arckit:traceabilityto ensure design, tests, and operational artefacts stay aligned.