Skip to content

Jiab77/ai-framework

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

AI Framework

A lightweight, project-agnostic framework for working effectively with AI models during development. Built from real-world experience across 40+ production sessions with Claude, GPT-4, and custom AI coding assistants. Now evolved into a highly-efficient 4-component architecture (3 Markdown blueprints + 1 structured JSON ledger) for total alignment and seamless continuity.

Philosophy

Most AI frameworks focus on what the AI should know. This one focuses on what the AI should remember, how it should behave, and how collaboration between human and AI should actually work. The framework enforces an Anti-Assistant / Technical Partner posture and is inspired in part by Andrej Karpathy's coding guidelines.

Core Components

Component Target File Type / Access Purpose
AGENTS.md v3/AGENTS.md Static
AI Read-Only
Collaboration Framework. Defines the organization, loading sequence, file permissions, and roles.
SOUL.md v3/SOUL.md Static
Discussion-only
Shared Principles & Doctrines. Stores core technical values (DRY, KISS, Zero Trust, OWASP), debugging protocol, and critical execution rules.
HUMAN.md
or HUMANS.md
v3/HUMAN.md
v3/HUMANS.md
Static & Private
AI Read-Only
Human Collaborator Profile(s). Adapts the AI's persona, communication style, tech stack, and workflow. Must be gitignored.
memory.json (Created locally) Dynamic
AI Read/Write
Structured Session Memory. Stores project state, recent blockers, lessons learned, and session progress logs.

Note

The previous versions of this framework can be found in the v1 and v2 folders.

How It Works

Session Init Sequence

At the start of every session, the AI must process the core files in this exact order:

  1. SOUL.md — Sync with core technical values, philosophies, and strict execution rules.
  2. HUMAN.md (or HUMANS.md) — Align with user profile, communication preferences, and team context.
  3. memory.json — Load the current project state, recent blockers, and past lessons learned.

Critical Execution Rules

Embedded directly in SOUL.md to ensure they are codified into the AI's core behavior:

  1. Ask, don't guess — Surface confusion before writing code. A clarifying question saves hours; a wrong assumption wastes them.
  2. Minimum code — Write the absolute minimum amount of code required to solve the problem. No speculative abstractions, no unrequested/bloated architecture.
  3. Surgical changes — Focus modifications narrowly. Ensure zero collateral damage on the existing codebase; do not touch unrelated files or adjacent lines.
  4. Define done first — State the verifiable success criteria first. Implementation is complete when that criterion is met, not when the code looks right.

The PDCA Debugging Protocol (Enforced in SOUL.md)

To eliminate the "trial-and-error" loop, the AI operates under a strict Plan ➔ Do ➔ Check ➔ Act cycle, prioritizing deep analysis, reproduction, and diagnostic isolation before making any modifications.

Usage

🚀 New Project

  1. Copy the core framework files into your project root.
  2. Choose between HUMAN.md (Solo project) or HUMANS.md (Team project) and delete the other.
  3. ⚠️ CRITICAL OPSEC: Immediately add HUMAN.md, HUMANS.md and memory.json to your .gitignore file.
  4. Fill in your profile/preferences in your human context file.
  5. Create or let the AI initialize the structured memory.json memory file, and start hacking.
# Example setup for v3
cp /path/to/framework/v3/{AGENTS.md,SOUL.md,HUMAN.md} ./
echo "memory.json" >> .gitignore
echo "HUMAN.md" >> .gitignore
echo "HUMANS.md" >> .gitignore

What Makes This Different

  • Dual-Layer Memory — Separation between static rules (SOUL.md) and dynamic project state (memory.json) ensuring high focus without cluttering the AI's system prompt or context window.
  • Structured Schema — Transitioning from Markdown logging to structured JSON for the dynamic session memory allows fast, zero-parser-error reads by the LLM.
  • Strict OPSEC & Privacy — Human context is strictly separated and kept local via .gitignore to prevent leaking private workflows, proprietary API keys, or team identities to public repositories.
  • Zero Sycophancy — Designed to form a dry, direct, and elite technical sparring partner that actively challenges poor development decisions or unnecessary complexity.

Credits

Star History

Star History Chart

About

AI Framework files used when AI models are being involved in the development process.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors