| name | doc-requirements |
| description | Phase 2 (Requirements). Use to turn analysis candidates into Functional Requirements, Use Cases, and NFR references - ask the SWE for exact behavior, acceptance criteria, actors, flows, priorities, and NFR targets, then write the registry rows and per-package FR/UC files. Trigger on "write the FRs", "draft use cases", "define acceptance criteria", "specify NFRs". |
Doc: Requirements (Phase 2)
Promote analysis candidates into testable FRs, complete UCs, and referenced NFRs. Owns Phase 2 only (WORKFLOWS.md, QUALITY-GUIDE.md, SCHEMA.md). Consumes doc-analysis output; hands Approved requirements to doc-design.
Inputs
- Classified candidates + priorities + open questions from
Analysis/Analysis.md.
- Target package(s) and DomainCode.
Process (elicitation loop)
- Read the candidate table and existing registries/detail files.
- For each FR/UC candidate, ask the relevant batch from the bank.
- Write: add registry rows (
FR-Registry/FRs.md, UC-Registry/UCs.md), create per-package detail files named after the ID, fill all sections, set reciprocal FR<->UC links, reference impacted NFR IDs in UC section 9.
- Re-read; check atomicity, testability, missing alternates/edge cases; ask a follow-up batch.
- Repeat until DoD. Keep unresolved as Draft. Hand off Approved IDs to
doc-design.
Questions to ask (bank)
- FR behavior: For candidate X, what exactly shall the system do? (one behavior per FR)
- Priority: Must, Should, or Could? Target release?
- Acceptance: Given/When/Then for success, boundary, and failure - what are they?
- UC actors: Primary and supporting actors? Trigger?
- UC flow: Preconditions? Main flow (3-7 steps)? Alternate/error flows? Postconditions? Business rules?
- NFR: Which NFRs does this flow depend on (performance, security, availability, ...)? Concrete targets/numbers?
- Mapping: Which UCs realize which FRs, and vice versa?
Outputs (creates / updates)
FR-Registry/FRs.md + Packages/<Package>/FR-*.md (Identification, Description "system shall ...", Acceptance Criteria, Constraints, Traceability).
UC-Registry/UCs.md + Packages/<Package>/UC-*.md (actors, trigger, pre/flows/post, business rules, NFR section 9, related FRs).
NFRs.md (add/refine NFR entries referenced by UCs).
Definition of Done (gate)
FRs atomic and testable; UCs complete; reciprocal FR<->UC links; NFR IDs referenced in UC section 9; registry rows in sync with detail files. (LIFECYCLE.md Phase 2.)
Handoff
Approved FR/UC/NFR IDs + the entities named in their flows -> doc-design.
Guardrails
Append-only IDs; filename matches ID; canonical Status (Draft|In Review|Approved|Deprecated) and Priority (Must|Should|Could); ASCII; preserve templates; ask - do not speculate. Note: no "Implemented" status. See SCHEMA.md, QUALITY-GUIDE.md.