031-architecture-adr-functional-requirements

Solid

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. This should trigger for requests such as Create ADR for functional requirements; Document functional requirements; Capture functional requirements; Generate functional requirements in an ADR. Part of cursor-rules-java project

AI & Automation 404 stars 80 forks Updated today Apache-2.0

Install

View on GitHub

Quality Score: 93/100

Stars 20%
87
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# 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 c...

Details

Author
jabrena
Repository
jabrena/cursor-rules-java
Created
1 years ago
Last Updated
today
Language
Java
License
Apache-2.0

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category