| name | 031-architecture-adr-functional-requirements |
| description | Facilitates conversational discovery to create Architectural Decision Records (ADRs) for functional requirements covering CLI, REST/HTTP APIs, or both. Use when the user wants to document command-line or HTTP service architecture, capture functional requirements, create ADRs for CLI or API projects, or design interfaces with documented decisions. Part of the skills-for-java project |
| license | Apache-2.0 |
| metadata | {"author":"Juan Antonio Breña Moral","version":"0.13.0-SNAPSHOT"} |
Create ADRs for Functional Requirements (CLI and/or REST API)
Guide stakeholders through a structured conversation to uncover and document technical decisions and functional requirements for command-line tools, REST/HTTP APIs, or combined surfaces. This is an interactive SKILL. The ADR is the documentation of that conversation, not the conversation itself. Infer CLI vs API from project context when possible; ask a short clarifying question when unclear.
What is covered in this Skill?
- Surface discovery: CLI, REST/HTTP API, or both (inference + confirmation)
- Initial context: purpose, users/consumers, constraints, timeline, load (API when relevant)
- Functional requirements: surface-specific workflows, I/O, resources, errors
- Technical decisions: language/framework; REST blocks (API design, auth, data, infra, testing/monitoring) and/or CLI blocks (architecture, data/integration, testing/distribution)
- Decision synthesis and validation before ADR creation
- ADR document generation and next steps
Constraints
Use conversational discovery—ask 1-2 questions at a time, build on answers, validate before proceeding. Only create ADR after thorough conversation and user confirmation.
- MANDATORY: Run
date before starting to get accurate timestamps for the ADR
- MUST: Read the reference template fresh—do not use cached questions
- MUST: Ask one or two questions at a time; never all at once
- MUST: Validate summary with user ("Does this accurately capture your requirements?") before proposing ADR creation
- MUST: Wait for user to confirm "proceed" before generating the ADR
When to use this skill
- Document CLI or REST architecture
- Create ADR for functional requirements
- ADR for command-line tool or HTTP API
- Functional requirements ADR
Reference
For detailed guidance, examples, and constraints, see references/031-architecture-adr-functional-requirements.md.
