Initial commit: antigravity-ipa-workflow
This commit is contained in:
111
README.md
Normal file
111
README.md
Normal file
@@ -0,0 +1,111 @@
|
||||
# Antigravity IPA Workflow
|
||||
|
||||
Intelligent Project Automation (IPA) — a stage-gated documentation workflow for AI-assisted software development, now as Antigravity IDE skills.
|
||||
|
||||
## IPA Workflow
|
||||
|
||||
```mermaid
|
||||
graph LR
|
||||
L[Lean Analysis] --> S1[Stage 1: Spec]
|
||||
S1 --> S2[Stage 2: Design]
|
||||
S2 --> S3[Stage 3: Detail]
|
||||
S3 --> S4[Stage 4: Validate]
|
||||
S4 --> I[Implementation]
|
||||
```
|
||||
|
||||
| Stage | Skill | Output |
|
||||
|-------|-------|--------|
|
||||
| Pre-spec | lean, lean-analyst | MVP scope, user research |
|
||||
| Stage 1 | ipa-spec | SRD.md + UI_SPEC.md |
|
||||
| Stage 2 | ipa-design | HTML mockups |
|
||||
| Stage 3 | ipa-detail | API_SPEC.md + DB_DESIGN.md |
|
||||
| Stage 4 | ipa-validate | Traceability matrix |
|
||||
| Full pipeline | ipa-all, ipa-fast | All stages sequentially |
|
||||
|
||||
## Installation
|
||||
|
||||
### Global (all projects)
|
||||
|
||||
```bash
|
||||
./install.sh --global
|
||||
# Skills install to ~/.gemini/antigravity/skills/
|
||||
```
|
||||
|
||||
### Workspace (current project — also copies doc templates)
|
||||
|
||||
```bash
|
||||
./install.sh --workspace
|
||||
# Skills install to .agent/skills/
|
||||
# Doc templates copied to ./docs/ (SRD.md, UI_SPEC.md, etc.)
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
.\install.ps1
|
||||
# or: .\install.ps1 -Workspace
|
||||
```
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Antigravity IDE (Gemini CLI)
|
||||
- No dependency on antigravity-claudekit (fully standalone)
|
||||
- Optional: install [antigravity-claudekit](https://github.com/user/antigravity-claudekit) for full CK workflow
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
"Generate requirements for a user auth feature" → ipa-spec activates
|
||||
"Create UI mockups" → ipa-design activates
|
||||
"Generate API spec and database design" → ipa-detail activates
|
||||
"Validate documentation traceability" → ipa-validate activates
|
||||
"Run full IPA pipeline" → ipa-all activates
|
||||
```
|
||||
|
||||
## Stage Gates
|
||||
|
||||
Each stage enforces prerequisites:
|
||||
- **ipa-design** requires SRD.md to exist (run ipa-spec first)
|
||||
- **ipa-detail** requires UI_SPEC.md to exist (run ipa-design first)
|
||||
- **ipa-validate** requires API_SPEC.md + DB_DESIGN.md (run ipa-detail first)
|
||||
|
||||
## Skill List
|
||||
|
||||
### IPA Core
|
||||
ipa-spec, ipa-srd, ipa-design, ipa-detail, ipa-validate, ipa-all, ipa-fast, ipa-start, ipa-help
|
||||
|
||||
### IPA Support
|
||||
ipa-bd, ipa-dd, ipa-context-aware-planning, ipa-docs, ipa-docs-split, ipa-docs-sync, ipa-import, ipa-init, ipa-mockup-analyze, ipa-planner, ipa-validator
|
||||
|
||||
### Lean Analysis
|
||||
lean, lean-analyst, lean-analyze-usage, lean-user-research
|
||||
|
||||
## Project Template
|
||||
|
||||
The `templates/` directory provides a bootstrappable project structure:
|
||||
- `templates/docs/SRD.md.template` — Requirements spec skeleton
|
||||
- `templates/docs/UI_SPEC.md.template` — UI specification skeleton
|
||||
- `templates/docs/API_SPEC.md.template` — API specification skeleton
|
||||
- `templates/docs/DB_DESIGN.md.template` — Database design skeleton
|
||||
|
||||
Use `./install.sh --workspace` to auto-copy these into your project.
|
||||
|
||||
## Contributing
|
||||
|
||||
1. Fork this repo
|
||||
2. Create a skill in `skills/<name>/SKILL.md` following `template/SKILL.md`
|
||||
3. Add entry to `skills_index.json`
|
||||
4. Submit PR
|
||||
|
||||
## Migration from IPA-for-CK
|
||||
|
||||
See [docs/migration-guide-from-ipa-for-ck.md](docs/migration-guide-from-ipa-for-ck.md).
|
||||
|
||||
Key differences:
|
||||
- Colon names → hyphens (`ipa:spec` → `ipa-spec`)
|
||||
- No slash commands → semantic triggering
|
||||
- Stage gates use HARD-GATE blocks instead of hooks
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user