Skip to content

AIris - Clear vision for AI-assisted development. A constraint-first framework for maintaining architectural coherence across AI sessions.

Notifications You must be signed in to change notification settings

Phoenix-Calibration/ai-assisted-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

87 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AIris

Clear vision for AI-assisted development

A constraint-first framework that ensures AI understands your architecture before suggesting code. Like the human iris focuses light to create clear vision, AIris focuses AI on your technical constraints to create coherent, maintainable software.


What is AIris?

AIris is a document-driven framework for AI-assisted development that prevents common pitfalls like architectural drift, scope creep, and inconsistent technical decisions across sessions.

The Problem: When AI reads requirements before understanding technical constraints, it suggests generic "path of least resistance" solutions that often violate your architectural decisions.

The AIris Solution: Architecture-first AI development. See the structure before writing code.


Key Innovation

Constraint-First Methodology: AIris ensures technical decisions guide AI suggestions rather than AI suggesting generic solutions.

Traditional AI Development:
User: "I need a chat feature"
AI: "Let's use Firebase!" ❌
(Ignores your FastAPI + PostgreSQL architecture)

With AIris:
AI reads: design.md → "FastAPI + PostgreSQL only"
Then reads: requirements.md → "Need chat feature"
AI suggests: "Server-Sent Events in FastAPI" ✅
(Respects your constraints)

Framework Structure

After installation, you'll have:

.airis/
├── README.md                      # Complete framework documentation
├── _setup/
│   ├── templates/                 # 7 document templates
│   │   ├── 0-PRD.template.md
│   │   ├── 1-scope.template.md
│   │   ├── 2-requirements.template.md
│   │   ├── 3-design.template.md
│   │   ├── 4-tracker.template.md
│   │   ├── 5-todo.template.md
│   │   └── 6-handoff.template.md
│   ├── prompts/                   # 6 AI prompts
│   │   ├── 1-discovery.prompt.md
│   │   ├── 2-scope.prompt.md
│   │   ├── 3-requirements.prompt.md
│   │   ├── 4-design.prompt.md
│   │   ├── 5-tracker.prompt.md
│   │   └── 6-session.prompt.md
│   └── instructions/              # Claude Project instructions
│       ├── airis-integration.instructions.md
│       └── airis-session.instructions.md
├── docs/                          # Placeholder examples
└── session/                       # Session workspace

Quick Start

Step 1: Install AIris (see above)

Step 2: Read the Docs

# Main documentation
.airis/README.md

# Installation guide
INSTALLATION.md

Step 3: Create Your Strategy Documents

For NEW projects:

  1. Create docs/scope.md - Define vision and boundaries
  2. Create docs/requirements.md - Detail features and stories
  3. Create docs/design.md - Make technical decisions

For EXISTING projects:

  1. Document current architecture in docs/design.md
  2. Document current vision in docs/scope.md
  3. Document existing features in docs/requirements.md

Step 4: Use AI Prompts

Copy prompts from .airis/_setup/prompts/ into your AI chat to generate your documents.

📖 Complete Guide


Framework Flow

Human Creates Strategy (Scope → Requirements → Design)
             ↓
AI Generates Tactics (Tracker with all tasks)
             ↓
AI Executes Sessions (ToDo → Work → Handoff)
             ↓
          Repeat

The AIris Principle: AI reads documents in constraint-first order:

  1. Design (technical constraints - non-negotiable)
  2. Scope (project boundaries)
  3. Requirements (features to implement)

This ensures AI suggestions respect your architecture.


Key Features

👁️ Constraint-First Methodology

  • Technical decisions guide AI suggestions
  • Prevents generic "path of least resistance" solutions
  • Maintains architectural coherence across all sessions

📚 Document Hierarchy

  • Strategy (months) - Scope, Requirements, Design
  • Tactics (weeks) - Task Tracker
  • Execution (hours) - Session ToDo
  • Transfer (per session) - Handoff state

🤖 6 Consolidated Prompts

  • Phase 1: 4 prompts for strategic documents
  • Phase 2: 1 prompt for tracker generation
  • Phase 3: 1 unified prompt for session lifecycle

👥 Multi-Developer Support

  • Per-developer workspaces
  • Parallel development workflows
  • Shared team coordination

Benefits

  • Architectural Coherence - Technical constraints enforced across all sessions
  • Clear Vision - Like an iris focuses light, AIris focuses AI on what matters
  • Scope Control - Clear boundaries prevent feature creep
  • Auditable Trail - ADRs document all technical decisions
  • Fast Onboarding - New team members read strategy docs
  • AI-Agnostic - Works with Claude, GPT-4, Gemini, any LLM
  • Multi-Developer - Parallel workflows with conflict resolution
  • Adaptable - Works for new projects and existing codebases

Documentation

Main Documentation

Templates & Prompts


Philosophy

"Like the human iris controls how much light enters the eye to create clear vision, AIris controls how AI reads your project documents to create clear, coherent software."

The AIris Way:

  1. See clearly - Architecture and constraints first
  2. Focus precisely - Boundaries and scope defined
  3. Build confidently - Requirements guide implementation

🚀 Quick Install

Choose your preferred method:

Option 1: Installation Script (Recommended)

Windows (PowerShell):

Invoke-WebRequest -Uri "https://raw.githubusercontent.com/Phoenix-Calibration/ai-assisted-framework/main/install-airis.ps1" -OutFile "install-airis.ps1"
.\install-airis.ps1

Linux/Mac (Bash):

curl -O https://raw.githubusercontent.com/Phoenix-Calibration/ai-assisted-framework/main/install-airis.sh
chmod +x install-airis.sh
./install-airis.sh

Option 2: One-Line Command

Windows:

git clone --depth 1 https://github.com/Phoenix-Calibration/ai-assisted-framework.git temp-airis; Copy-Item -Path "temp-airis\.airis" -Destination "." -Recurse; Remove-Item -Path "temp-airis" -Recurse -Force

Linux/Mac:

git clone --depth 1 https://github.com/Phoenix-Calibration/ai-assisted-framework.git temp-airis && cp -r temp-airis/.airis . && rm -rf temp-airis

Option 3: NPM/Node.js Projects

# Coming soon - will be available as NPM package
# npx install-airis

📖 Full Installation Guide


Source & Credits

Based on: From Fast Code to Reliable Software: A Framework for AI-Assisted Development by Stanislav Komarovsky

Developed by: Phoenix Calibration Team

Key Innovations:

  • ✨ Constraint-first methodology (dual document ordering)
  • ✨ Requirements.md as separate strategic document
  • ✨ Consolidated prompts (6 vs 13+ original)
  • ✨ Multi-developer workspaces
  • ✨ Unified session prompt with 3-part lifecycle
  • ✨ Architecture-first naming and branding (AIris)

Status

Version: 1.0 (January 2026)

Status: ✅ Production Ready

  • ✅ All 7 templates complete
  • ✅ All 6 prompts complete
  • ✅ Documentation complete
  • ✅ Multi-developer workflow tested
  • ✅ Installation scripts ready

Support

Resources

  • Documentation: .airis/README.md
  • Installation Help: INSTALLATION.md
  • Templates: .airis/_setup/templates/
  • Prompts: .airis/_setup/prompts/
  • Instructions: .airis/_setup/instructions/

Issues

Open an issue on GitHub for:

  • Bug reports
  • Feature requests
  • Installation problems
  • Documentation improvements

License

Private - Phoenix Calibration


Get Started

  1. Install: Use one of the methods above
  2. Read: .airis/README.md for complete guide
  3. Create: Your strategy documents
  4. Build: With AI-assisted confidence

Ready to see clearly? 👁️ Let AIris guide your AI-assisted development.


See clearly. Build confidently. 👁️

About

AIris - Clear vision for AI-assisted development. A constraint-first framework for maintaining architectural coherence across AI sessions.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published