3.4 KiB
3.4 KiB
name: ipa-help
description: Display the IPA workflow quick reference cheatsheet with commands, warnings, tips, and workflow paths. Use when you need a summary of available IPA commands, want to understand the full pipeline at a glance, or need to share workflow guidance. Trigger phrases: "ipa help", "show ipa commands", "ipa cheatsheet".
Overview
Displays the IPA workflow quick reference with all commands, critical warnings, tips, and workflow paths for different project scenarios.
When to Use
- Need a summary of all IPA commands and their purpose
- Onboarding to the IPA workflow for the first time
- Want to verify the correct command sequence
- Sharing workflow guidance with collaborators
Don't Use When
- You need to actually run a workflow step (use the specific skill instead)
Output
Display the following cheatsheet:
IPA QUICK REFERENCE
───────────────────────────────────────────────────────
FAST MODE (Power Users)
ipa-fast "idea" Full workflow, no prompts
WARNING: Skips all gates — use only when confident
STEP-BY-STEP (Recommended)
lean "idea" → MVP analysis [GATE 1]
ipa-spec → SRD + UI_SPEC [GATE 2]
ipa-design → HTML mockups [GATE 3]
ipa-detail → API_SPEC + DB_DESIGN
plan → code → Implementation
UTILITIES
ipa-init Extract docs from existing code
ipa-import @file Import external SRS document
ipa-validate Check traceability matrix
ipa-docs-sync Sync docs with implementation
ipa-start Interactive wizard
───────────────────────────────────────────────────────
CRITICAL WARNINGS
1. PLANNING WITH CONTEXT
ALWAYS include docs + mockups when planning:
CORRECT: plan @docs/ @prototypes/html-mockups/
WRONG: plan "implement feature"
Why? Ensures:
- Traceability: FR-xx → S-xx → E-xx → T-xx
- Accurate UI: Code matches mockup exactly
- Design tokens: Colors, fonts, spacing applied
2. DOCS SYNC REQUIRES HUMAN REVIEW
After coding, run: ipa-docs-sync
REVIEW CHANGES before accepting
Never auto-approve without checking
3. GATE VALIDATION
GATE 1: After lean
- 3+ user interviews about problem
- Scope ≤ 3 phases
GATE 2: After ipa-spec
- Stakeholder reviewed SRD
- Priorities confirmed (P1/P2/P3)
GATE 3: After ipa-design
- 5+ user testing sessions
- Usability issues addressed
4. TRACEABILITY IDs
FR-xx → Functional Requirement (SRD)
S-xx → Screen (UI_SPEC)
E-xx → API Endpoint (API_SPEC)
T-xx → Database Table (DB_DESIGN)
Check with: ipa-validate
TIPS
First time? Run ipa-start for guided setup
Large docs? Split with: ipa-docs-split API_SPEC
External SRS? Import with: ipa-import @file.md
Check coverage: ipa-validate shows traceability matrix
WORKFLOWS
New Project (step-by-step):
lean → ipa-spec → ipa-design → ipa-detail → plan @docs/ @prototypes/
New Project (fast):
ipa-fast "idea" → plan @docs/ @prototypes/
Existing (no docs):
ipa-init → lean [feature] → plan @docs/
Existing (has docs):
lean [feature] → plan @docs/ → code → ipa-docs-sync
Import external:
ipa-import @srs.md → ipa-design → ipa-detail → plan