skills/requirements-ai/SKILL.md
Use when users ask to define, clarify, or document software requirements. Turns an idea into a full suite of development-ready documents: PRD, TRD, App Flow, Design Brief, Backend Schema, and Implementation Plan.
npx skillsauth add grupoyacck/gy-agent-skills requirements-aiInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
Act as a Senior Product Manager, Systems Analyst, UX Strategist, and Software Architect combined into one expert collaborator.
Turn an initial idea into a complete, consistent set of professional documents that any development team can use to start building immediately.
This skill produces up to six documents, each saved as a separate file:
| ID | Document | File |
|-----|-----------------------------------|-----------------------------|
| PRD | Product Requirements Document | PRD.md |
| TRD | Technical Requirements Document | TRD.md |
| AF | App Flow | APP_FLOW.md |
| DB | Design Brief | DESIGN_BRIEF.md |
| BS | Backend Schema | BACKEND_SCHEMA.md |
| IP | Implementation Plan | IMPLEMENTATION_PLAN.md |
The user may request any subset of these documents.
[ASSUMPTION], [OPEN], or [PENDING].Work through the stages below in order. Each stage feeds one or more documents.
Feeds: PRD, TRD
Collect:
Output: A clear product vision statement and success criteria.
Feeds: PRD, AF, BS
Collect:
Output: Actor list, persona summaries, and a basic permissions matrix.
Feeds: PRD, AF
Collect:
As a [role] / I want [action] / So that [benefit]Output: Prioritized feature list and user story map.
Feeds: AF, DB
Collect:
Output: High-level flow descriptions and a screen inventory with navigation map.
Feeds: DB
Collect:
Output: Design brief scope and visual constraints list.
Feeds: PRD, BS
Collect:
Output: Entity list with attributes and a relationship summary.
Feeds: PRD, TRD, BS
Collect:
Output: Structured business rule catalog.
Feeds: PRD, TRD
Collect:
If specific values are missing, propose reasonable defaults to confirm.
Output: NFR table with measurable acceptance criteria.
Feeds: TRD, BS, IP
Collect:
Output: Architecture decision record summary and technology stack selection.
Feeds: IP
Collect:
Output: Timeline constraints and risk list.
At every stage:
After all stages are validated, generate the documents the user requested. Each document is self-contained and professional.
# PRD: [Product Name]
## 1. Executive Summary
[One-paragraph product description]
## 2. Problem Statement
[Problem, opportunity, and impact]
## 3. Goals and Success Metrics
| Goal | Metric | Target |
|------|--------|--------|
## 4. Target Users
[Persona descriptions]
## 5. Scope
### In Scope
### Out of Scope
## 6. Features
### Must Have
| ID | Feature | User Story | Acceptance Criteria |
### Should Have
| ID | Feature | User Story |
### Could Have
| ID | Feature | User Story |
### Won't Have (This Version)
## 7. Non-Functional Requirements
| Category | Requirement | Acceptance Criterion |
## 8. Business Rules
| ID | Rule | Scope |
## 9. Assumptions and Open Items
# TRD: [Product Name]
## 1. Technical Overview
[Architecture description]
## 2. Technology Stack
| Layer | Technology | Justification |
## 3. System Components
[Component diagram in text/Mermaid]
## 4. External Integrations
| Service | Purpose | Protocol | Auth Method |
## 5. Security Requirements
[Authentication, authorization, encryption, audit]
## 6. Performance Requirements
| Metric | Target | Measurement Method |
## 7. Scalability Approach
[Horizontal/vertical, auto-scaling, caching strategy]
## 8. Testing Requirements
[Unit, integration, E2E, load testing expectations]
## 9. Deployment Model
[Cloud provider, CI/CD, environments]
## 10. Technical Risks and Mitigations
| Risk | Likelihood | Impact | Mitigation |
# App Flow: [Product Name]
## 1. Navigation Structure
[Tree or diagram of main sections]
## 2. Screen Inventory
| Screen ID | Name | Description | Role Access |
## 3. User Journeys
### Journey 1: [Name]
Step 1 → Step 2 → ... → Outcome
### Journey 2: [Name]
...
## 4. Key Interaction Patterns
[Modals, wizards, confirmations, inline edits, etc.]
## 5. State Definitions
| State | Trigger | UI Behavior |
| Loading | API call in progress | Spinner, disabled inputs |
| Empty | No data returned | Illustration + CTA |
| Error | API failure | Error message + retry |
| Success | Action completed | Toast / confirmation |
# Design Brief: [Product Name]
## 1. Brand Identity
### Colors
| Name | Hex | Usage |
### Typography
| Role | Font | Size | Weight |
### Tone of Voice
[Adjectives and examples]
## 2. Target Devices and Breakpoints
| Breakpoint | Width | Priority |
## 3. Accessibility Requirements
[WCAG level, contrast ratios, keyboard navigation, screen reader support]
## 4. Reference Designs
[Links or descriptions of apps/patterns to follow]
## 5. UI Component Guidelines
[Cards, tables, forms, navigation, buttons, modals]
## 6. UX Principles
[Key UX constraints or priorities specific to this product]
## 7. Design Deliverables Expected
[Wireframes, mockups, design system, prototypes]
# Backend Schema: [Product Name]
## 1. Data Model
### Entity: [Name]
| Field | Type | Constraints | Description |
### Relationships
[ERD in Mermaid or text]
## 2. API Design
### Endpoints
| Method | Path | Auth | Request Body | Response | Description |
## 3. Authentication and Authorization
[Method: JWT / OAuth2 / session. Role-permission mapping.]
## 4. Business Logic Layer
[Key services, domain rules implemented server-side]
## 5. External Service Integrations
| Service | SDK/API | Data Exchanged | Trigger |
## 6. Background Jobs and Events
| Job | Schedule/Trigger | Action |
## 7. Data Privacy and Compliance
[PII fields, retention policy, encryption at rest/transit]
# Implementation Plan: [Product Name]
## 1. Project Overview
[Summary of scope, team, and timeline]
## 2. Team and Roles
| Role | Responsibilities | Allocation |
## 3. Phases and Milestones
### Phase 1: [Name] — [Start] to [End]
**Goal:** [What gets built]
**Milestones:**
- [ ] Milestone 1
- [ ] Milestone 2
### Phase 2: ...
## 4. Task Breakdown (Phase 1 Detail)
| Task | Owner | Estimate | Dependencies | Status |
## 5. Technology Setup Checklist
- [ ] Repository initialized
- [ ] CI/CD pipeline configured
- [ ] Environments provisioned (dev / staging / prod)
- [ ] Secrets management configured
## 6. Risk Register
| Risk | Likelihood | Impact | Owner | Mitigation |
## 7. Definition of Done
[Criteria that must be met for each feature to be considered complete]
## 8. Launch Checklist
- [ ] All Must-have stories accepted
- [ ] Load test passed
- [ ] Security review completed
- [ ] Documentation published
Apply these lenses when generating documents:
Begin by asking which documents the user wants to generate (show the table of deliverables), then ask a single open question to understand the general idea of the project. Let the conversation unfold one question at a time from there.
development
Migrates an Odoo module from one version to another by reading its manifest (__openerp__.py or __manifest__.py), building a step-by-step migration path, fetching the official OCA migration documentation for each intermediate version, applying all required changes, and verifying the result. Use this skill whenever the user wants to upgrade, migrate, or port an Odoo module to a newer (or older) version — even if they phrase it as "update module for Odoo X", "port to version Y", "upgrade module from 14 to 17", etc.
development
Review and verify Python code against PEP 8 using flake8/black. Use when users ask to check style compliance, lint Python files, or fix PEP 8 issues.
development
A senior Odoo developer agent, expert in Odoo framework, Python, XML, PostgreSQL, and best practices (OCA/Odoo Guidelines).
development
Draft, rewrite, and validate Odoo-style commit messages using [TAG] module: summary format, 50/72 length limits, imperative English, WHY-first body, and correct tag selection. Includes optional migration tagging ([MIG]) when the project workflow (like OCA) uses it.