project-iris 0.0.16 → 0.0.18

package/README.md

@@ -52,7 +52,7 @@ iris provides four specialized agents that guide you through the entire developm
 | Phase | Agent | Purpose | Key Outputs |
 |-------|-------|---------|-------------|
 | **Inception** | Inception Agent | Capture intents, elaborate requirements, decompose into units | User stories, NFRs, Unit definitions, Bolt plans |
-| **Construction** | Construction Agent | Execute bolts through domain design → logical design → code → test | Domain models, Technical designs, Code, Tests |
+| **Construction** | Construction Agent | Execute bolts through Domain Design → Logical Design → Code Generation → Testing | Domain designs, Logical designs, Code, Tests |
 | **Operations** | Operations Agent | Deploy, verify, and monitor | Deployment units, Monitoring, Runbooks |
 
 ---
@@ -115,16 +115,61 @@ The agent will:
 ```
 
 Each bolt goes through validated stages:
-1. **Domain Model** - Model business logic using DDD principles
-2. **Technical Design** - Apply patterns and make architecture decisions
+1. **Domain Design** - Model business logic using DDD principles
+2. **Logical Design** - Apply patterns and make architecture decisions
 3. **ADR Analysis** - Document significant decisions (optional)
-4. **Implement** - Generate production code
-5. **Test** - Verify correctness with automated tests
+4. **Code Generation** - Generate production code
+5. **Testing** - Verify correctness with automated tests
 
 **Human validation happens at each stage gate.**
 
 ---
 
+## Project Scenarios
+
+iris supports both new projects and existing codebases.
+
+### Greenfield (New Projects)
+
+Starting fresh with no existing code:
+
+```bash
+/iris-master-agent
+# Then type: project-init
+```
+
+1. Initialize project with standards (tech stack, coding standards, architecture)
+2. Begin Inception phase immediately
+3. Build from scratch using AI-DLC methodology
+
+### Brownfield (Existing Codebases)
+
+Adding features to an existing codebase requires understanding what's already there:
+
+```bash
+/iris-master-agent
+# Then type: code-elevate
+```
+
+**Code Elevation** analyzes your existing codebase and creates:
+
+- **Static Model** (`memory-bank/elevation/static-model.md`)
+  - Components and their responsibilities
+  - Relationships between components
+  - Key abstractions and patterns used
+
+- **Dynamic Model** (`memory-bank/elevation/dynamic-model.md`)
+  - How components interact for significant use cases
+  - Request/response flows
+  - Event chains and data transformations
+
+After code elevation, agents have full context about your existing architecture, enabling them to:
+- Propose changes that fit existing patterns
+- Identify integration points for new features
+- Avoid breaking existing functionality
+
+---
+
 ## Key Concepts
 
 ### Intent
@@ -138,8 +183,8 @@ The smallest iteration in AI-DLC, designed for rapid implementation. Unlike Spri
 
 | Type | Best For | Stages |
 |------|----------|--------|
-| **DDD Construction** | Complex business logic, domain modeling | Model → Design → ADR → Implement → Test |
-| **Simple Construction** | UI, integrations, utilities | Plan → Implement → Test |
+| **DDD Construction** | Complex business logic, domain modeling | Domain Design → Logical Design → ADR → Code Generation → Testing |
+| **Simple Construction** | UI, integrations, utilities | Plan → Code Generation → Testing |
 
 ### Memory Bank
 File-based storage for all project artifacts. Maintains context across agent sessions and provides traceability between artifacts.
@@ -164,17 +209,40 @@ After installation:
     └── memory-bank.yaml       # Memory bank schema
 
 memory-bank/                   # Created after project-init
+├── project.yaml               # Project configuration
+│
+├── elevation/                 # Brownfield code analysis (if applicable)
+│   ├── static-model.md        # Components, responsibilities, relationships
+│   └── dynamic-model.md       # Use case interactions
+│
 ├── intents/                   # Your captured intents
-│   └── {intent-name}/
-│       ├── requirements.md
-│       ├── system-context.md
+│   └── {NNN}-{intent-name}/
+│       ├── requirements.md    # Functional & non-functional requirements
+│       ├── prfaq.md           # Press Release / FAQ
+│       ├── risks.md           # Risk assessment
+│       ├── system-context.md  # System boundaries & actors
+│       ├── units.md           # Unit decomposition overview
 │       └── units/
+│           └── {UUU}-{unit-name}/
+│               ├── unit-brief.md
+│               └── stories/
+│
 ├── bolts/                     # Bolt execution records
+│   └── {BBB}-{unit-name}/
+│       ├── bolt.md            # Bolt instance metadata
+│       ├── ddd-01-domain-design.md
+│       ├── ddd-02-logical-design.md
+│       ├── adr-{N}-{slug}.md  # ADR (optional)
+│       └── ddd-03-test-report.md
+│
 ├── standards/                 # Project standards
 │   ├── tech-stack.md
 │   ├── coding-standards.md
-│   └── ...
+│   └── system-architecture.md
+│
 └── operations/                # Deployment context
+    ├── deployment-units/
+    └── playbooks/
 ```
 
 ---
@@ -188,6 +256,7 @@ memory-bank/                   # Created after project-init
 | Command | Purpose |
 |---------|---------|
 | `project-init` | Initialize project with standards |
+| `code-elevate` | Analyze existing codebase (brownfield) |
 | `analyze-context` | View current project state |
 | `route-request` | Get directed to the right agent |
 | `explain-flow` | Learn about AI-DLC methodology |
@@ -199,9 +268,10 @@ memory-bank/                   # Created after project-init
 ```
 | Command | Purpose |
 |---------|---------|
-| `intent-create` | Create a new intent |
+| `intent-create` | Create a new intent with PRFAQ |
 | `intent-list` | List all intents |
-| `requirements` | Elaborate intent requirements |
+| `requirements` | Gather requirements with measurements |
+| `risks` | Assess risks with mitigations |
 | `context` | Define system context |
 | `units` | Decompose into units |
 | `story-create` | Create stories for a unit |
@@ -225,10 +295,11 @@ memory-bank/                   # Created after project-init
 ```
 | Command | Purpose |
 |---------|---------|
-| `build` | Build the project |
+| `build` | Build deployment artifacts |
 | `deploy` | Deploy to environment |
 | `verify` | Verify deployment |
-| `monitor` | Set up monitoring |
+| `monitor` | Set up monitoring and SLOs |
+| `rollback` | Rollback to previous version |
 
 ---