@codihaus/claude-skills 1.6.6 → 1.6.7

package/skills/dev-scout/references/output-template.md

@@ -0,0 +1,231 @@
+# Scout Output Templates
+
+## Principle
+
+**Capture:** Stable patterns, rules, and conventions (what won't change soon)
+**Don't Capture:** Volatile inventory like file lists, component counts, route lists
+
+---
+
+## 1. Project-Level: tech-context.md
+
+**Location:** `plans/brd/tech-context.md`
+**Purpose:** Document HOW the project works (patterns, rules, conventions)
+**Length:** ~150-200 lines
+
+### Structure
+
+```markdown
+# Project Technical Context
+
+> **Last Updated**: {date}
+> **Purpose**: Document HOW we work, not WHAT files exist
+> **Previous**: [history/tech-context-{prev-date}.md]
+
+## Summary
+{2-3 sentences: what the app does}
+
+**Project Type**: {type}
+**Primary Stack**: {stack}
+
+## Tech Stack (Why These?)
+
+| Layer | Choice | Why This? |
+|-------|--------|-----------|
+| Frontend | | |
+| Backend | | |
+| Database | | |
+| Auth | | |
+
+## Architecture Patterns (How We Build)
+
+### 1. API Communication
+**How:** {pattern description}
+**Rule:** {what must be followed}
+**Example:** {code example showing pattern}
+**Why:** {reason}
+
+### 2. Data Access
+{same structure}
+
+### 3. Client-Side Data Fetching
+{same structure}
+
+### 4. Validation & Forms
+{same structure}
+
+### 5. State Management
+{same structure}
+
+## Code Conventions (Team Standards)
+
+### Naming
+| Type | Convention | Example |
+|------|------------|---------|
+
+### File Organization
+{where different types go}
+
+### Imports
+{pattern}
+
+### Code Style
+{standards}
+
+## Git & Team Process
+
+### Commits
+{format}
+
+### Branches
+{pattern}
+
+### PRs
+{requirements}
+
+## Integration Points
+
+### External Services
+{how we use them}
+
+### Local Services
+{docker-compose services}
+
+### Available MCPs
+{what they provide}
+
+## Project Structure (High-Level)
+
+{core directories only, not exhaustive}
+
+**Where to put new code:**
+{guidelines}
+
+## Rules & Constraints
+
+**Must Follow:**
+{critical rules}
+
+**Forbidden:**
+{what not to do}
+
+**From CLAUDE.md:**
+{project-specific rules}
+
+## For Downstream Skills
+
+{guidelines for /dev-specs and /dev-coding}
+
+### Stack Knowledge References
+{links to knowledge base if applicable}
+
+## Changes Since Last Scout
+{pattern changes, not file changes}
+
+## Notes
+{gotchas, pain points}
+```
+
+---
+
+## 2. Feature-Level: codebase-context.md
+
+**Location:** `plans/features/{feature}/codebase-context.md`
+**Purpose:** How THIS feature works (implementation details, not patterns)
+**Prerequisite:** MUST read tech-context.md first (patterns already documented)
+**Length:** ~100-150 lines
+
+### Structure
+
+```markdown
+# {Feature} - Codebase Context
+
+> **Date**: {date}
+> **Feature**: [[feature-{feature}]]
+> **Related UCs**: [[uc-{group}-001]]
+> **Patterns**: See [tech-context.md](../../brd/tech-context.md)
+
+## Summary
+{what this feature does}
+
+**Status**: {Complete | Partial | Planned | Not Started}
+
+## How It Works
+
+{2-3 paragraphs explaining flow}
+
+**Flow:**
+1. {step}
+2. {step}
+3. {step}
+
+## Architecture
+
+**Entry Point:** `{file}` - {purpose}
+**Uses Pattern:** {reference to tech-context.md pattern}
+**Data Flow:** {diagram or description}
+
+## Key Files
+
+| File | Role | Why Important |
+|------|------|---------------|
+
+## How This Feature Uses Project Patterns
+
+**API Communication:**
+{which APIs, where}
+
+**Data Access:**
+{which models, how}
+
+**State Management:**
+{where state lives}
+
+**Validation:**
+{where schemas are}
+
+## Integration Points
+
+**Where to add new code:**
+{location + pattern}
+
+**What to extend:**
+{existing abstraction}
+
+**Dependencies:**
+{what must exist}
+
+**Used By:**
+{what depends on this}
+
+## Patterns to Follow
+
+**✅ DO:**
+{feature-specific guidance}
+
+**❌ DON'T:**
+{feature-specific anti-pattern}
+
+## Gotchas
+
+{feature-specific issues}
+
+## For Implementation
+
+**Start here:** `{file}` - {why}
+**Follow pattern:** See tech-context.md → {section}
+**Watch out:** {warning}
+```
+
+---
+
+## Key Difference
+
+| Project Scout | Feature Scout |
+|---------------|---------------|
+| HOW we work (patterns) | HOW this feature works |
+| Project-wide conventions | Feature-specific details |
+| Pattern definition | Pattern usage |
+| Reusable across features | Specific to feature |
+
+Feature scout **references** tech-context.md, doesn't **repeat** it.