Intent Layer Onboarding
Use an existing Intent Layer to quickly orient yourself (or a new team member) in a codebase.
Prerequisites
- •Project must have Intent Layer state =
complete - •Run
intent-layerskill first if state isnoneorpartial
Quick Start
# Check Intent Layer exists
${CLAUDE_PLUGIN_ROOT}/scripts/detect_state.sh /path/to/project
# Generate orientation overview
scripts/generate_orientation.sh /path/to/project
# View hierarchy
${CLAUDE_PLUGIN_ROOT}/scripts/show_hierarchy.sh /path/to/project
The 15-Minute Orientation
Get productive in a new codebase in 15 minutes using this workflow.
Step 1: Read the Root (2 min)
Read the root CLAUDE.md or AGENTS.md completely. Focus on:
- •TL;DR - One sentence project purpose
- •Subsystem Boundaries - Major areas and owners
- •Contracts - Global rules that apply everywhere
- •Pitfalls - Surprises that bite newcomers
# Find and display root node cat /path/to/project/CLAUDE.md || cat /path/to/project/AGENTS.md
Step 2: Map the Hierarchy (2 min)
Visualize the full Intent Layer structure:
${CLAUDE_PLUGIN_ROOT}/scripts/show_hierarchy.sh /path/to/project
Note:
- •How many child nodes exist
- •Which areas have the most documentation (complexity signals)
- •Depth of hierarchy (shallow = simple, deep = complex)
Step 3: Identify Your Entry Point (3 min)
Based on your role or first task, find where to start:
| If your role is... | Start with... |
|---|---|
| Frontend engineer | UI/components AGENTS.md |
| Backend engineer | API/services AGENTS.md |
| DevOps/Platform | Infrastructure AGENTS.md |
| Full-stack | Root node + busiest subsystem |
| If your first task is... | Find... |
|---|---|
| Bug fix in area X | AGENTS.md closest to X |
| New feature | Entry Points in relevant subsystem |
| Understanding flow | Root → follow data path |
Step 4: Deep-Read Your Area (5 min)
For your identified entry point:
- •Read the specific AGENTS.md completely
- •Note the Entry Points - these are your starting files
- •Note the Contracts - rules you must follow
- •Note the Pitfalls - traps to avoid
Step 5: Verify Understanding (3 min)
Test your mental model:
- •Can you explain the project in one sentence?
- •Do you know where your first change goes?
- •Do you know what rules apply to that area?
- •Do you know what NOT to do?
If any answer is "no", re-read the relevant node.
Role-Based Onboarding
For AI Agents
When an AI agent needs to understand a new codebase:
Minimum context load:
- •Root node (always)
- •Node for target area (if known)
- •Ancestors of target (for inherited constraints)
Query pattern:
"I need to [task] in [area]. What should I know?"
Response pattern:
## Context for [task] ### Relevant Node `path/to/AGENTS.md` ### Key Constraints - [From local node] - [Inherited from ancestors] ### Entry Point Start at: `path/to/file.ts` ### Watch Out For - [Pitfall 1] - [Pitfall 2]
For New Engineers
When a human is joining the team:
Day 1 Goals:
- •Understand project purpose (root TL;DR)
- •Know major subsystems (root Subsystem Boundaries)
- •Know global rules (root Contracts)
- •Know what surprises exist (root Pitfalls)
Week 1 Goals:
- •Deep-read your team's AGENTS.md files
- •Understand your area's specific contracts
- •Successfully complete one small task
- •Know where to ask questions
Onboarding Checklist:
## Onboarding Checklist: [Name] ### Day 1 - [ ] Read root CLAUDE.md/AGENTS.md - [ ] Run show_hierarchy.sh to see structure - [ ] Identify which subsystem I'll work in - [ ] Read my subsystem's AGENTS.md ### Week 1 - [ ] Complete first small task - [ ] Verify I followed all contracts - [ ] Note any confusion for Intent Layer feedback - [ ] Ask about anything not documented
For Code Reviewers
When reviewing code in an unfamiliar area:
- •Find AGENTS.md for the changed files
- •Check Contracts section - are they followed?
- •Check Pitfalls section - are they avoided?
- •Check Anti-patterns section - none introduced?
Task-Based Onboarding
"I need to fix a bug in X"
Workflow:
- •Find AGENTS.md nearest to X
- •Read Pitfalls (often explains the bug)
- •Read Contracts (constraints on the fix)
- •Find Entry Point for debugging
Output:
## Bug Fix Context: [area] **Relevant Node:** `path/to/AGENTS.md` **Common Pitfalls (check these first):** - [Pitfall that might explain bug] **Fix Constraints:** - [Rules the fix must follow] **Start Debugging At:** - `path/to/entry/file.ts`
"I need to add a feature to Y"
Workflow:
- •Find AGENTS.md for Y
- •Check if feature is in scope (vs out of scope)
- •Read Entry Points for "add new..."
- •Read Contracts for implementation rules
- •Check parent nodes for inherited constraints
Output:
## Feature Context: [feature] in [area] **In Scope:** Yes/No (from AGENTS.md) **Entry Point:** - Start at: `path/to/file.ts` - Pattern to follow: [from Entry Points] **Constraints:** - [Local rules] - [Inherited rules] **Related Areas:** - [Siblings that might be affected]
"I need to understand how Z works"
Workflow:
- •Find AGENTS.md that owns Z
- •Read TL;DR for high-level understanding
- •Read Architecture Decisions for rationale
- •Follow Entry Points to key files
- •Read ancestors for broader context
Output:
## Understanding: [Z] **Owner:** `path/to/AGENTS.md` **TL;DR:** > [From node] **Why It's Designed This Way:** - [From Architecture Decisions] **Key Files to Read:** 1. `file1.ts` - [purpose] 2. `file2.ts` - [purpose] **Broader Context:** - [From parent nodes]
Generating Orientation Documents
For teams that want a static onboarding doc:
Quick Overview
scripts/generate_orientation.sh /path/to/project --format overview
Produces:
- •Project summary
- •Subsystem map
- •Global rules
- •Common tasks entry points
Full Onboarding Guide
scripts/generate_orientation.sh /path/to/project --format full
Produces:
- •Everything in overview
- •Per-subsystem deep dives
- •Role-based entry points
- •First-week checklist
Team-Specific
scripts/generate_orientation.sh /path/to/project --role backend
Produces:
- •Filtered view for backend engineers
- •Relevant subsystems only
- •Backend-specific entry points
Interactive Onboarding Session
For a guided, interactive orientation:
Step 1: Gather Context
Ask the newcomer:
- •What's your role? (frontend/backend/fullstack/devops/other)
- •What's your first task? (if known)
- •What's your experience level? (junior/mid/senior)
Step 2: Generate Personalized Path
Based on answers, create a reading list:
Junior + No specific task:
## Your Onboarding Path 1. **Start Here:** CLAUDE.md (root) - 10 min read 2. **Then:** [area matching role]/AGENTS.md - 5 min read 3. **Exercise:** Find where [simple task] would be done 4. **Verify:** Explain the project back to me
Senior + Specific task:
## Your Onboarding Path 1. **Quick Scan:** CLAUDE.md TL;DR + Subsystems - 2 min 2. **Deep Read:** [task area]/AGENTS.md - 5 min 3. **Context:** Walk ancestors for inherited rules - 3 min 4. **Start:** [Entry point for task]
Step 3: Verify Understanding
After they complete the path, ask:
- •"What does this project do in one sentence?"
- •"Where would you make your first change?"
- •"What rules must you follow there?"
- •"What mistakes should you avoid?"
If answers are weak, point them to specific sections.
Step 4: Capture Gaps
If they found the Intent Layer confusing or incomplete:
### Intent Layer Feedback | Type | Location | Finding | |------|----------|---------| | Unclear | `src/api/AGENTS.md` | Entry Points don't explain X | | Missing | `CLAUDE.md` | No mention of Y subsystem |
Feed this back via intent-layer-maintenance skill.
Common Questions
"Where do I start?"
- •Run
show_hierarchy.shto see structure - •Read root node for project overview
- •Identify your area from Subsystem Boundaries
- •Read that area's AGENTS.md
- •Follow its Entry Points
"What can I safely change?"
- •Find AGENTS.md for the area
- •Check Contracts - these are invariants
- •Check Anti-patterns - don't introduce these
- •Anything not constrained is fair game
"Who owns this code?"
- •Find nearest AGENTS.md (walk up if needed)
- •Check TL;DR for ownership statement
- •Check Subsystem Boundaries in parent for team info
"Why is it done this way?"
- •Find AGENTS.md for the area
- •Check Architecture Decisions section
- •Follow any ADR links
- •If not documented, flag as feedback
Parallel Onboarding (Teams & Multiple Roles)
For onboarding multiple people or generating comprehensive multi-role documentation, use parallel subagents.
When to Use Parallel Onboarding
| Scenario | Approach |
|---|---|
| Single person, known role | Sequential (standard 15-min workflow) |
| Single person, exploring roles | Parallel role summaries |
| Multiple new team members | Parallel per-person paths |
| Comprehensive onboarding docs | Parallel section generation |
Parallel Role Summaries
Generate role-specific orientations simultaneously:
Task 1 (Explore): "Generate frontend engineer orientation from Intent Layer.
Focus on: UI components, state management, styling patterns.
Return: relevant nodes, key contracts, entry points, pitfalls"
Task 2 (Explore): "Generate backend engineer orientation from Intent Layer.
Focus on: API layer, database, services, integrations.
Return: relevant nodes, key contracts, entry points, pitfalls"
Task 3 (Explore): "Generate DevOps/platform orientation from Intent Layer.
Focus on: infrastructure, CI/CD, deployment, monitoring.
Return: relevant nodes, key contracts, entry points, pitfalls"
Output: Three role-specific onboarding guides generated in parallel.
Parallel Comprehensive Documentation
Generate full onboarding documentation in parallel sections:
Task 1 (Explore): "Extract project overview from Intent Layer root.
Return: TL;DR, architecture overview, subsystem map"
Task 2 (Explore): "Extract all global contracts and pitfalls from Intent Layer.
Return: merged constraints list, common mistakes to avoid"
Task 3 (Explore): "Extract all entry points across Intent Layer nodes.
Return: task → starting point mapping for common tasks"
Task 4 (Explore): "Identify complexity hotspots from Intent Layer.
Return: areas with most contracts/pitfalls (need careful reading)"
Synthesis: Combine into comprehensive onboarding document.
Parallel Task-Context Generation
When newcomer has multiple potential first tasks:
Task 1 (Explore): "Generate context for 'fix login bug' task.
Find: relevant node, constraints, pitfalls, entry point"
Task 2 (Explore): "Generate context for 'add new API endpoint' task.
Find: relevant node, constraints, pitfalls, entry point"
Task 3 (Explore): "Generate context for 'update dashboard component' task.
Find: relevant node, constraints, pitfalls, entry point"
Output: Three task-context summaries, let newcomer pick their starting point.
Parallel Codebase Exploration
For AI agents needing to understand unfamiliar codebase quickly:
Task 1 (Explore): "Read CLAUDE.md root node. Extract: purpose, subsystems,
global constraints, and identify which child nodes exist"
Task 2 (Explore): "For each child AGENTS.md, extract: ownership scope,
key contracts, main pitfalls. Return summary table"
Task 3 (Explore): "Map data flow through system using Intent Layer.
How does data move between subsystems?"
Synthesis: Complete mental model of codebase in ~5 minutes vs ~15 minutes sequential.
Example: Parallel Team Onboarding
Scenario: 3 new engineers joining (1 frontend, 1 backend, 1 fullstack)
Parallel execution:
Task 1: "Create onboarding path for frontend engineer.
- Identify UI-related AGENTS.md nodes
- Extract frontend-specific contracts and pitfalls
- List frontend entry points for common tasks
- Generate Day 1 and Week 1 checklist"
Task 2: "Create onboarding path for backend engineer.
- Identify API/service AGENTS.md nodes
- Extract backend-specific contracts and pitfalls
- List backend entry points for common tasks
- Generate Day 1 and Week 1 checklist"
Task 3: "Create onboarding path for fullstack engineer.
- Identify cross-cutting AGENTS.md nodes
- Extract integration contracts and pitfalls
- List full-stack entry points
- Generate Day 1 and Week 1 checklist"
Output: Three personalized onboarding documents in parallel.
Parallel Onboarding Benefits
| Scenario | Sequential | Parallel |
|---|---|---|
| 3-role documentation | ~30 min | ~10 min |
| 5-person team onboarding | ~75 min | ~15 min |
| Comprehensive docs (4 sections) | ~40 min | ~12 min |
Scripts Reference
| Script | Purpose |
|---|---|
generate_orientation.sh | Create onboarding documents |
show_hierarchy.sh | Visualize Intent Layer structure |
show_status.sh | Check Intent Layer health |
query_intent.sh | Search for specific concepts |
walk_ancestors.sh | Gather context from hierarchy |
Scripts from intent-layer: ${CLAUDE_PLUGIN_ROOT}/scripts/
Scripts from intent-layer-query: ${CLAUDE_PLUGIN_ROOT}/scripts/
Anti-Patterns
| Don't Do This | Do This Instead |
|---|---|
| Skip root, jump to code | Always read root first |
| Read all nodes exhaustively | Read root + your area |
| Ignore Pitfalls section | Pitfalls prevent 80% of mistakes |
| Assume contracts are optional | Contracts are hard requirements |
| Start coding without reading Entry Points | Entry Points show the correct starting place |
Success Metrics
After onboarding, the newcomer should be able to:
- •Explain - Describe project purpose in one sentence
- •Navigate - Find the right AGENTS.md for any task
- •Comply - Know constraints that apply to their area
- •Avoid - Know common pitfalls in their area
- •Start - Know exactly which file to open first
If any of these fail, the Intent Layer may need improvement via maintenance skill.