Skip to content

REPO_MAP.md

Latest commit

 

History

History
142 lines (109 loc) · 5.52 KB

REPO_MAP.md

File metadata and controls

142 lines (109 loc) · 5.52 KB

Repository Map

Find your path in 60 seconds.

A methodology framework for AI-assisted software development — checkpoints, escalation rules, and human oversight to ship quality code faster.

Who Is This For?

Profile Start Here Then Read
Apply to Your Project Bootstrap Guide Checkpoints → System Prompt
Learn the Workflow Agent Quickstart Escalation Rules
Scale to Teams Factory Model Multi-Agent → Metrics
Secure AI Code Security Module Security Gates → Audit Trail
See Examples Case Studies PHP/Symfony Example

Repository Structure

ai-driven-dev-instructions/
│
├── [Core Framework]
│   ├── core/
│   │   ├── agent-operating-model/   # Roles, workflow, escalation
│   │   ├── spec/                    # Checkpoints, templates
│   │   ├── security/                # DevSecOps for AI code [NEW]
│   │   │   ├── SECURE_CODE_GENERATION.md
│   │   │   ├── SECURITY_GATES.md
│   │   │   ├── SUPPLY_CHAIN_SECURITY.md
│   │   │   └── AUDIT_TRAIL.md
│   │   └── factory-model/           # Scale to teams [NEW]
│   │       ├── MULTI_AGENT_ORCHESTRATION.md
│   │       ├── BATCH_PIPELINE.md
│   │       ├── AUTOMATED_GATES.md
│   │       └── METRICS_DASHBOARD.md
│   │
│   ├── runtime/
│   │   ├── golden-path/             # Quickstarts, bootstrap
│   │   ├── prompts/                 # System prompts
│   │   └── quality-gates/           # Definition of Done
│   │
│   ├── bench/                       # Benchmark tasks
│   └── tools/                       # Validation utilities
│
├── [Examples]
│   └── php-symfony-k8s/             # Complete reference (52 docs)
│
├── [Case Studies]
│   └── case-studies/                # Real workflow examples
│
└── [Supporting]
    ├── README.md                    # Project overview
    ├── REPO_MAP.md                  # This file
    ├── METHODOLOGY.md               # Core methodology
    ├── GLOSSARY.md                  # Terminology
    ├── CONTRIBUTING.md
    └── LICENSE

Quick Start Paths

Path A: Apply to Your Project (Fastest)

  1. BOOTSTRAP_NEW_PROJECT.md — Choose your setup level
  2. CHECKPOINTS.md — Understand the workflow
  3. ESCALATION_RULES.md — Know when to stop

Minimum setup: 2 files (Micro option)

Path B: Understand the Methodology

  1. README.md — What problem this solves
  2. QUICKSTART_AGENT.md — The core workflow
  3. Case Studies — See real examples

Path C: Secure AI-Generated Code

  1. Security README — Overview
  2. SECURE_CODE_GENERATION.md — Prompts and rules
  3. SECURITY_GATES.md — CI/CD integration
  4. AUDIT_TRAIL.md — Traceability

Path D: Scale to Teams

  1. Factory Model README — Overview
  2. AUTOMATED_GATES.md — Start here (highest value)
  3. BATCH_PIPELINE.md — Overnight generation
  4. MULTI_AGENT_ORCHESTRATION.md — Coordinate agents

Path E: Benchmark Agent Performance

  1. bench/README.md — Benchmark overview
  2. bench/tasks/ — 10 benchmark tasks
  3. bench/scoring/ — Scoring rubric

Key Concepts

Term Definition
Checkpoint Validation gate (C0=scope, C1=plan, C2=implement, C3=PR)
Escalation When AI must pause and ask the human
Fast Path Minimal workflow for trivial changes (< 10 lines)
Golden Path Fastest route from issue to merged PR
Factory Model Scale: multiple agents, batch processing, metrics

See GLOSSARY.md for complete terminology.

Adoption Levels

Level What You Get Files
Micro Checkpoints + PR template 2
Minimal + Issue templates, agent guide 6
Full + Full operating model, prompts 15+
Factory + Security, scale, metrics 25+

Component Overview

Component Purpose When to Use
Checkpoints Structure work into stages Always
Escalation Rules Know when AI should ask Always
Quality Gates Define "done" by task type Always
Security Module Secure AI-generated code When security matters
Factory Model Scale beyond 1 dev + 1 AI Team-scale projects
Benchmarks Measure agent performance Optimization

Last updated: 2026-02-05