AI Developer Guide
Instructions for AI coding assistants working on this project.
Why This System
AI coding assistants are powerful but need structure to be effective. This system has three layers:
- The Cage — The AI runs inside a devcontainer. It can only see the project directory. Your machine, SSH keys, and other projects are protected.
- The Plan — The AI creates a plan before writing code. You review it. This prevents hallucinations, scope drift, and wasted work.
- The Tests — Validation catches mistakes. The AI runs checks after each phase and self-corrects before you review.
Documents
| Document | Purpose | When to Read |
|---|---|---|
| WORKFLOW.md | End-to-end flow from idea to implementation | When starting new work |
| PLANS.md | Plan structure, investigation guidance, templates | When creating or implementing a plan |
| DEVCONTAINER.md | How to work inside the devcontainer | When running commands or installing tools |
| GIT.md | Git safety rules and platform operations | When doing git operations |
| TALK.md | AI-to-AI testing protocol | When working with a tester |
Start Here
When starting a new session, read files in this order:
- Read all
project-*.mdfiles — project-specific setup, tools, commands, conventions - Read all
template-*.mdfiles (if any) — tech stack from installed templates - Read WORKFLOW.md when starting new work
- Read PLANS.md when creating or implementing a plan
- Reference DEVCONTAINER.md, GIT.md, TALK.md as needed
File Naming Convention
| Prefix | Meaning | Portable? | Created by |
|---|---|---|---|
| (none) | Universal workflow docs | Yes — copy to any project | Copied from template |
project-* | Project-specific setup and conventions | No | Project maintainer |
template-* | Tech stack from installed template | No | dev-template command |
plans/ | Implementation plans | No | AI + maintainer |
Plans Folder
Implementation plans are stored in plans/:
plans/
├── backlog/ # Approved plans waiting for implementation
├── active/ # Currently being worked on (max 1-2 at a time)
└── completed/ # Done - kept for reference
File Types
| Type | When to use |
|---|---|
PLAN-*.md | Solution is clear, ready to implement |
INVESTIGATE-*.md | Needs research first, approach unclear |
Quick Reference
When user says "I want to add X" or "Fix Y":
- Create
INVESTIGATE-*.mdorPLAN-*.mdinplans/backlog/ - Ask user to review the plan
- Wait for approval before implementing
When user approves a plan:
- Ask: "Do you want to work on a feature branch? (recommended)"
- Create branch if yes
- Move plan to
plans/active/ - Implement phase by phase
- Ask user to confirm after each phase
When implementation is complete:
- Move plan to
plans/completed/ - Create Pull Request if on feature branch
Project-Specific Instructions
See CLAUDE.md in the repo root for always-loaded rules (workflow enforcement, container rule).
See project-*.md files in this directory for project-specific setup, tools, and conventions.