88 lines
2.4 KiB
Markdown
88 lines
2.4 KiB
Markdown
---
|
|
name: ipa-all
|
|
description: Run the full IPA documentation pipeline in sequence — spec, design, detail, validate. Use when you want to generate all IPA docs in one command, need a complete documentation pass for a project, or are a power user comfortable skipping individual validation gates. Trigger phrases: "generate all IPA docs", "full IPA pipeline", "run ipa all".
|
|
---
|
|
|
|
> WARNING: This skill chains all IPA stages without stopping at individual validation gates.
|
|
>
|
|
> Recommended step-by-step flow:
|
|
> ```
|
|
> lean → ipa-spec → ipa-design → ipa-detail
|
|
> ```
|
|
>
|
|
> Use ipa-all only for rapid prototyping, existing projects with established docs, or when you understand the risks.
|
|
|
|
## Overview
|
|
|
|
Generate all IPA documentation in sequence:
|
|
1. SRD (System Requirement Definition)
|
|
2. UI_SPEC (Basic Design)
|
|
3. API_SPEC + DB_DESIGN (Detail Design)
|
|
4. Validation report (auto-run at end)
|
|
|
|
## When to Use
|
|
|
|
- Rapid prototyping or throwaway code
|
|
- Existing projects where full docs are needed quickly
|
|
- Power users who understand IPA gates and accept the risk
|
|
|
|
## Don't Use When
|
|
|
|
- First time using IPA workflow
|
|
- Complex enterprise projects with multiple stakeholders
|
|
- User research or scope validation has not been completed
|
|
- You want gate checkpoints between phases
|
|
|
|
## Workflow
|
|
|
|
### Step 1: Generate SRD
|
|
|
|
Read requirements from arguments, `docs/requirements.md`, or `docs/PRD.md`. Generate `docs/SRD.md` with 14 IPA sections. Wait for user approval before continuing.
|
|
|
|
### Step 2: Generate UI_SPEC
|
|
|
|
Read `docs/SRD.md`. Generate `docs/UI_SPEC.md`. Optionally generate HTML mockups. Wait for user approval.
|
|
|
|
### Step 3: Generate Detail Design
|
|
|
|
Read `docs/SRD.md` + `docs/UI_SPEC.md`. Generate `docs/API_SPEC.md` and `docs/DB_DESIGN.md`. Wait for user approval.
|
|
|
|
### Step 4: Validate
|
|
|
|
Run ipa-validate logic automatically. Check ID consistency (FR-xx, S-xx, E-xx) and traceability chain. Report errors and warnings.
|
|
|
|
## Output
|
|
|
|
```
|
|
docs/
|
|
├── SRD.md
|
|
├── UI_SPEC.md
|
|
├── API_SPEC.md
|
|
├── DB_DESIGN.md
|
|
└── tech-stack.md (if created)
|
|
|
|
ui-mockup/ (optional)
|
|
```
|
|
|
|
## Traceability Chain
|
|
|
|
```
|
|
Requirements
|
|
↓
|
|
SRD.md (FR-xx, S-xx, E-xx)
|
|
↓
|
|
UI_SPEC.md (S-xx → Screen specs)
|
|
↓
|
|
API_SPEC.md (API ↔ FR-xx ↔ S-xx)
|
|
DB_DESIGN.md (Table ↔ E-xx)
|
|
↓
|
|
plan → Tasks ref docs/
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
After all docs generated and validated:
|
|
1. Review validation report
|
|
2. Fix any errors found
|
|
3. Run planning skill to create implementation tasks
|