requirements-engineering-skill
SwiftyJourney/requirements-engineering-skill
Turn vague requirements into testable specs: BDD narratives, use cases, payload contracts, flowcharts, and dependency diagrams - Agent Skill
Instalação
npx convez-ai SwiftyJourney/requirements-engineering-skill1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.
Métricas
README
A tradução para o português deste README ainda está na fila.
Requirements Engineering Agent Skill
A Claude Code skill that transforms vague or incomplete requirements into well-defined, testable specifications using BDD, Use Cases, Model Specs, Payload Contracts, flowcharts, and architecture diagrams.
Who is this for?
Anyone who encounters vague requirements and needs to transform them into implementable specifications:
- Product Managers defining feature requirements
- Software Teams bridging business and technical needs
- Developers needing clear specs before writing code
- Technical Writers structuring project documentation
Installation
Install via skills.sh:
npx skills add SwiftyJourney/requirements-engineering-skill
Compatible Agents
- Claude Code
- Cursor
- GitHub Copilot
- Windsurf
- Any agent supporting the
skills/convention
What the Skill Covers
The 7 Feature Specification Artifacts
Every feature specification includes these artifacts:
- BDD Narrative — Define who, what, why per user type
- Acceptance Criteria — Given/When/Then scenarios
- Use Cases — Step-by-step system behavior (Data/Primary/Error/Cancel)
- Model Specs — Property/Type tables for domain entities
- Payload Contract — HTTP method + path + response JSON
- Flowchart — Decision flow with error branches
- Architecture Diagram — Module dependency graph
The 6-Step Process
- Identify — Recognize vague requirements
- Clarify — Ask Who/What/Where/When/Why/How
- Specify BDD — Write narratives and acceptance criteria
- Define Use Cases — Procedural steps with cancel courses
- Model & Contract — Property/Type tables and JSON payloads
- Visualize & Document — Diagrams and feature specification
Key Patterns
- Cancel courses — First-class cancellation requirements for async operations
- Separation of concerns — Extract focused use cases (Load vs Validate vs Cache)
- Domain language alignment — Consistent terminology across all artifacts
- Incremental feature development — Self-contained feature blocks
- Living specification — Requirements evolve with code
Skill File Structure
requirements-engineering/
├── SKILL.md # Hub + diagnostic table + gotchas + reference router
└── references/
├── bdd-narratives.md # BDD stories, narratives, acceptance criteria
├── use-cases.md # Use case structure, courses, CQS, separation of concerns
├── model-specs-and-contracts.md # Model specs, payload contracts, abstract core, JSON examples
├── diagrams.md # Flowcharts, four-type dependency notation, architecture, state
├── domain-language.md # Terminology alignment, ubiquitous language, renaming
└── feature-specification-workflow.md # End-to-end workflow, traceability
evals/ # Trigger eval queries + output-quality test cases
Related Skills
- iOS Architecture Expert — Clean modular architecture: composition root, protocol boundaries, generic presenters, Swift 6 concurrency
- SwiftUI Expert — SwiftUI view code: state, composition, performance, animations, accessibility
- SwiftUI ⇄ UIKit Interop — Bridge SwiftUI and UIKit: hosting controllers, representables, data across the boundary
- Swift Language Expert — Non-obvious Swift language & standard-library techniques
Credits
Requirements methodology and artifact format distilled from a real-world iOS case study (an image-feed app) whose README documents the canonical BDD narratives, use cases, payload contracts, and dependency diagrams.
License
MIT — see LICENSE.