Skip to content

Commit f6ff8fe

Browse files
Add AGENT.md to structure agent work
1 parent c3ea65d commit f6ff8fe

1 file changed

Lines changed: 57 additions & 0 deletions

File tree

AGENT.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Agent Organization System
2+
3+
## Directory Structure
4+
5+
The project uses a three-tier organization system in the `agent/` directory:
6+
7+
- `agent/plans/` - High-level concepts and goals
8+
- `agent/tasks/` - Actionable implementation items
9+
- `agent/docs/` - Current codebase reality documentation
10+
11+
## Naming Conventions
12+
13+
### Plans and Tasks
14+
- Format: `NNN_descriptive_name_max_seven_words.md`
15+
- Use auto-incrementing numbers (001, 002, etc.)
16+
- Maximum 7 words in description
17+
- Use underscores between words
18+
19+
### Docs
20+
- Format: `subsystem_context.md`
21+
- Named by subsystem and specific context they document
22+
- Designed for easy reference by future agent sessions
23+
24+
## Content Structure
25+
26+
### Plans
27+
- High-level concepts and goals
28+
- Reference target docs for changes
29+
- Never reference tasks (tasks reference plans)
30+
31+
### Tasks
32+
- **Change-request**: Intent and high-level description
33+
- **Plan reference**: Link to source plan (if applicable)
34+
- **Steps**: Precise file and language structure changes needed
35+
- **Doc references**: Target docs that will need updates
36+
37+
### Docs
38+
- Document current codebase reality
39+
- Reference source files only (never plans/tasks)
40+
- Single source of truth about current state
41+
42+
## Workflow
43+
44+
1. **Planning** → Create plan in `agent/plans/`
45+
2. **Task Generation** → Break plan into tasks in `agent/tasks/`
46+
3. **Implementation** → Execute task steps
47+
4. **Testing & Verification** → Confirm changes work
48+
5. **Documentation Update** → Update relevant docs in `agent/docs/`
49+
50+
## Reference Flow
51+
52+
- Tasks MAY reference Plans (optional)
53+
- Tasks/Plans MUST reference target Docs
54+
- Docs MUST reference source files only
55+
- No circular references allowed
56+
57+
This system ensures clear traceability from goals to implementation while maintaining docs as authoritative current state.

0 commit comments

Comments
 (0)