diff --git a/docs/index.html b/docs/index.html index ce44208..30ac848 100644 --- a/docs/index.html +++ b/docs/index.html @@ -272,14 +272,14 @@
-

Codify

+

Compound

Make sure you never solve the same bug twice

- Remember that CORS issue you debugged for three hours last month? Neither do I. That's the problem. Run /codify right after you fix something and it captures the solution as searchable documentation with YAML frontmatter. Next time someone hits the same issue, they grep for "CORS production" and find your answer in five seconds instead of re-debugging for three hours. That's how you compound. + Remember that CORS issue you debugged for three hours last month? Neither do I. That's the problem. Run /compound right after you fix something and it captures the solution as searchable documentation with YAML frontmatter. Next time someone hits the same issue, they grep for "CORS production" and find your answer in five seconds instead of re-debugging for three hours. That's how you compound.

- /codify - codify-docs skill + /compound + compound-docs skill file-todos skill
@@ -557,10 +557,10 @@
- /codify + /compound core
-

Document solved problems for the knowledge base. Turn learnings into reusable patterns.

+

Document solved problems to compound team knowledge. Turn learnings into reusable patterns.

@@ -736,11 +736,11 @@
- codify-docs + compound-docs Docs

Capture solved problems as categorized documentation with YAML schema.

- skill: codify-docs + skill: compound-docs
diff --git a/docs/pages/commands.html b/docs/pages/commands.html index 069a34b..c5be692 100644 --- a/docs/pages/commands.html +++ b/docs/pages/commands.html @@ -208,12 +208,12 @@ -
+
- /codify + /compound

- Just fixed a gnarly bug? This captures the solution before you forget it. Seven agents analyze what you did, why it worked, and how to prevent it next time. Your future self will thank you. + Just fixed a gnarly bug? This captures the solution before you forget it. Seven agents analyze what you did, why it worked, and how to prevent it next time. Each documented solution compounds your team's knowledge.

Arguments

[optional: brief context about the fix]

@@ -236,8 +236,8 @@

Auto-Triggers

Phrases: "that worked", "it's fixed", "working now", "problem solved"

- 
/codify
-/codify N+1 query optimization
+ 
/compound
+/compound N+1 query optimization
diff --git a/docs/pages/getting-started.html b/docs/pages/getting-started.html index 721fe64..418d784 100644 --- a/docs/pages/getting-started.html +++ b/docs/pages/getting-started.html @@ -335,7 +335,7 @@ claude agent git-history-analyzer "Show changes to user model" /plan /review 123 /work -/codify +/compound # Utility commands /changelog diff --git a/docs/pages/skills.html b/docs/pages/skills.html index 1fe4177..b33afd3 100644 --- a/docs/pages/skills.html +++ b/docs/pages/skills.html @@ -298,13 +298,13 @@ skill: create-agent-skills
-
+
-

codify-docs

+

compound-docs

Docs

- You just fixed a weird build error after an hour of debugging. Tomorrow you'll forget how you fixed it. This skill automatically detects when you solve something (phrases like "that worked" or "it's fixed") and documents it with YAML frontmatter so you can find it again. Think of it as a photographic memory for solved problems. + You just fixed a weird build error after an hour of debugging. Tomorrow you'll forget how you fixed it. This skill automatically detects when you solve something (phrases like "that worked" or "it's fixed") and documents it with YAML frontmatter so you can find it again. Each documented solution compounds your team's knowledge.

Auto-Triggers

Phrases: "that worked", "it's fixed", "working now", "problem solved"

@@ -328,7 +328,7 @@ skill: create-agent-skills
  • security-issues/
    • - 
    skill: codify-docs
    + 
    skill: compound-docs
    diff --git a/plugins/compounding-engineering/.claude-plugin/plugin.json b/plugins/compounding-engineering/.claude-plugin/plugin.json index c4a737e..020b44d 100644 --- a/plugins/compounding-engineering/.claude-plugin/plugin.json +++ b/plugins/compounding-engineering/.claude-plugin/plugin.json @@ -1,6 +1,6 @@ { "name": "compounding-engineering", - "version": "2.6.2", + "version": "2.7.0", "description": "AI-powered development tools. 23 agents, 16 commands, 11 skills, 2 MCP servers for code review, research, design, and workflow automation.", "author": { "name": "Kieran Klaassen", diff --git a/plugins/compounding-engineering/CHANGELOG.md b/plugins/compounding-engineering/CHANGELOG.md index bdb24f4..97e0ed9 100644 --- a/plugins/compounding-engineering/CHANGELOG.md +++ b/plugins/compounding-engineering/CHANGELOG.md @@ -5,6 +5,17 @@ All notable changes to the compounding-engineering plugin will be documented in The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [2.7.0] - 2025-11-27 + +### Changed + +- **`/codify` → `/compound`** - Renamed the documentation command to better reflect the compounding engineering philosophy. Each documented solution compounds your team's knowledge. The old `/codify` command still works but shows a deprecation notice and calls `/compound`. +- **`codify-docs` → `compound-docs`** - Renamed the skill to match the new command name. + +### Updated + +- All documentation, philosophy sections, and references updated to use `/compound` and `compound-docs` + ## [2.6.2] - 2025-11-27 ### Improved diff --git a/plugins/compounding-engineering/CLAUDE.md b/plugins/compounding-engineering/CLAUDE.md index 7fc46f1..c3f055c 100644 --- a/plugins/compounding-engineering/CLAUDE.md +++ b/plugins/compounding-engineering/CLAUDE.md @@ -35,7 +35,7 @@ agents/ └── docs/ # Documentation agents commands/ -├── workflows/ # Core workflow commands (/plan, /review, /work, /codify) +├── workflows/ # Core workflow commands (/plan, /review, /work, /compound) └── *.md # Utility commands skills/ diff --git a/plugins/compounding-engineering/README.md b/plugins/compounding-engineering/README.md index 1515e61..6cc4c80 100644 --- a/plugins/compounding-engineering/README.md +++ b/plugins/compounding-engineering/README.md @@ -74,7 +74,7 @@ Core workflow commands (use the short form for autocomplete): | `/plan` | Create implementation plans | | `/review` | Run comprehensive code reviews | | `/work` | Execute work items systematically | -| `/codify` | Document solved problems for knowledge base | +| `/compound` | Document solved problems to compound team knowledge | ### Utility Commands @@ -100,7 +100,7 @@ Core workflow commands (use the short form for autocomplete): | Skill | Description | |-------|-------------| | `andrew-kane-gem-writer` | Write Ruby gems following Andrew Kane's patterns | -| `codify-docs` | Capture solved problems as categorized documentation | +| `compound-docs` | Capture solved problems as categorized documentation | | `create-agent-skills` | Expert guidance for creating Claude Code skills | | `dhh-ruby-style` | Write Ruby/Rails code in DHH's 37signals style | | `dspy-ruby` | Build type-safe LLM applications with DSPy.rb | diff --git a/plugins/compounding-engineering/commands/workflows/codify.md b/plugins/compounding-engineering/commands/workflows/codify.md index 0f2c27e..69a022e 100644 --- a/plugins/compounding-engineering/commands/workflows/codify.md +++ b/plugins/compounding-engineering/commands/workflows/codify.md @@ -1,198 +1,17 @@ --- name: codify -description: Document a recently solved problem for the knowledge base +description: "[DEPRECATED] Use /compound instead - Document solved problems" argument-hint: "[optional: brief context about the fix]" --- -# /codify +# /codify is deprecated -Coordinate multiple subagents working in parallel to document a recently solved problem. +**This command has been renamed to `/compound`.** -## Purpose +The new name better reflects the compounding engineering philosophy: each documented solution compounds your team's knowledge. -Captures problem solutions while context is fresh, creating structured documentation in `docs/solutions/` with YAML frontmatter for searchability and future reference. Uses parallel subagents for maximum efficiency. +--- -## Usage +Tell the user: "Note: `/codify` has been renamed to `/compound`. Please use `/compound` going forward." -```bash -/codify # Document the most recent fix -/codify [brief context] # Provide additional context hint -``` - -## Execution Strategy: Parallel Subagents - -This command launches multiple specialized subagents IN PARALLEL to maximize efficiency: - -### 1. **Context Analyzer** (Parallel) - - Extracts conversation history - - Identifies problem type, component, symptoms - - Validates against CORA schema - - Returns: YAML frontmatter skeleton - -### 2. **Solution Extractor** (Parallel) - - Analyzes all investigation steps - - Identifies root cause - - Extracts working solution with code examples - - Returns: Solution content block - -### 3. **Related Docs Finder** (Parallel) - - Searches `docs/solutions/` for related documentation - - Identifies cross-references and links - - Finds related GitHub issues - - Returns: Links and relationships - -### 4. **Prevention Strategist** (Parallel) - - Develops prevention strategies - - Creates best practices guidance - - Generates test cases if applicable - - Returns: Prevention/testing content - -### 5. **Category Classifier** (Parallel) - - Determines optimal `docs/solutions/` category - - Validates category against schema - - Suggests filename based on slug - - Returns: Final path and filename - -### 6. **Documentation Writer** (Parallel) - - Assembles complete markdown file - - Validates YAML frontmatter - - Formats content for readability - - Creates the file in correct location - -### 7. **Optional: Specialized Agent Invocation** (Post-Documentation) - Based on problem type detected, automatically invoke applicable agents: - - **performance_issue** → `performance-oracle` - - **security_issue** → `security-sentinel` - - **database_issue** → `data-integrity-guardian` - - **test_failure** → `cora-test-reviewer` - - Any code-heavy issue → `kieran-rails-reviewer` + `code-simplicity-reviewer` - -## What It Captures - -- **Problem symptom**: Exact error messages, observable behavior -- **Investigation steps tried**: What didn't work and why -- **Root cause analysis**: Technical explanation -- **Working solution**: Step-by-step fix with code examples -- **Prevention strategies**: How to avoid in future -- **Cross-references**: Links to related issues and docs - -## Preconditions - - - - Problem has been solved (not in-progress) - - - Solution has been verified working - - - Non-trivial problem (not simple typo or obvious error) - - - -## What It Creates - -**Organized documentation:** - -- File: `docs/solutions/[category]/[filename].md` - -**Categories auto-detected from problem:** - -- build-errors/ -- test-failures/ -- runtime-errors/ -- performance-issues/ -- database-issues/ -- security-issues/ -- ui-bugs/ -- integration-issues/ -- logic-errors/ - -## Success Output - -``` -✓ Parallel documentation generation complete - -Primary Subagent Results: - ✓ Context Analyzer: Identified performance_issue in brief_system - ✓ Solution Extractor: Extracted 3 code fixes - ✓ Related Docs Finder: Found 2 related issues - ✓ Prevention Strategist: Generated test cases - ✓ Category Classifier: docs/solutions/performance-issues/ - ✓ Documentation Writer: Created complete markdown - -Specialized Agent Reviews (Auto-Triggered): - ✓ performance-oracle: Validated query optimization approach - ✓ kieran-rails-reviewer: Code examples meet Rails standards - ✓ code-simplicity-reviewer: Solution is appropriately minimal - ✓ every-style-editor: Documentation style verified - -File created: -- docs/solutions/performance-issues/n-plus-one-brief-generation.md - -This documentation will be searchable for future reference when similar -issues occur in the Email Processing or Brief System modules. - -What's next? -1. Continue workflow (recommended) -2. Link related documentation -3. Update other references -4. View documentation -5. Other -``` - -## Why This Matters - -This creates a compounding knowledge system: - -1. First time you solve "N+1 query in brief generation" → Research (30 min) -2. Document the solution → docs/solutions/performance-issues/n-plus-one-briefs.md (5 min) -3. Next time similar issue occurs → Quick lookup (2 min) -4. Knowledge compounds → Team gets smarter - -The feedback loop: - -``` -Build → Test → Find Issue → Research → Improve → Document → Validate → Deploy - ↑ ↓ - └──────────────────────────────────────────────────────────────────────┘ -``` - -## Auto-Invoke - - - "that worked" - "it's fixed" - "working now" - "problem solved" - - Use /codify [context] to document immediately without waiting for auto-detection. - -## Routes To - -`codify-docs` skill - -## Applicable Specialized Agents - -Based on problem type, these agents can enhance documentation: - -### Code Quality & Review -- **kieran-rails-reviewer**: Reviews code examples for Rails best practices -- **code-simplicity-reviewer**: Ensures solution code is minimal and clear -- **pattern-recognition-specialist**: Identifies anti-patterns or repeating issues - -### Specific Domain Experts -- **performance-oracle**: Analyzes performance_issue category solutions -- **security-sentinel**: Reviews security_issue solutions for vulnerabilities -- **cora-test-reviewer**: Creates test cases for prevention strategies -- **data-integrity-guardian**: Reviews database_issue migrations and queries - -### Enhancement & Documentation -- **best-practices-researcher**: Enriches solution with industry best practices -- **every-style-editor**: Reviews documentation style and clarity -- **framework-docs-researcher**: Links to Rails/gem documentation references - -### When to Invoke -- **Auto-triggered** (optional): Agents can run post-documentation for enhancement -- **Manual trigger**: User can invoke agents after /codify completes for deeper review - -## Related Commands - -- `/research [topic]` - Deep investigation (searches docs/solutions/ for patterns) -- `/plan` - Planning workflow (references documented solutions) +Now run the `/compound` command with the same arguments: #$ARGUMENTS diff --git a/plugins/compounding-engineering/commands/workflows/compound.md b/plugins/compounding-engineering/commands/workflows/compound.md new file mode 100644 index 0000000..dc4cde2 --- /dev/null +++ b/plugins/compounding-engineering/commands/workflows/compound.md @@ -0,0 +1,202 @@ +--- +name: compound +description: Document a recently solved problem to compound your team's knowledge +argument-hint: "[optional: brief context about the fix]" +--- + +# /compound + +Coordinate multiple subagents working in parallel to document a recently solved problem. + +## Purpose + +Captures problem solutions while context is fresh, creating structured documentation in `docs/solutions/` with YAML frontmatter for searchability and future reference. Uses parallel subagents for maximum efficiency. + +**Why "compound"?** Each documented solution compounds your team's knowledge. The first time you solve a problem takes research. Document it, and the next occurrence takes minutes. Knowledge compounds. + +## Usage + +```bash +/compound # Document the most recent fix +/compound [brief context] # Provide additional context hint +``` + +## Execution Strategy: Parallel Subagents + +This command launches multiple specialized subagents IN PARALLEL to maximize efficiency: + +### 1. **Context Analyzer** (Parallel) + - Extracts conversation history + - Identifies problem type, component, symptoms + - Validates against CORA schema + - Returns: YAML frontmatter skeleton + +### 2. **Solution Extractor** (Parallel) + - Analyzes all investigation steps + - Identifies root cause + - Extracts working solution with code examples + - Returns: Solution content block + +### 3. **Related Docs Finder** (Parallel) + - Searches `docs/solutions/` for related documentation + - Identifies cross-references and links + - Finds related GitHub issues + - Returns: Links and relationships + +### 4. **Prevention Strategist** (Parallel) + - Develops prevention strategies + - Creates best practices guidance + - Generates test cases if applicable + - Returns: Prevention/testing content + +### 5. **Category Classifier** (Parallel) + - Determines optimal `docs/solutions/` category + - Validates category against schema + - Suggests filename based on slug + - Returns: Final path and filename + +### 6. **Documentation Writer** (Parallel) + - Assembles complete markdown file + - Validates YAML frontmatter + - Formats content for readability + - Creates the file in correct location + +### 7. **Optional: Specialized Agent Invocation** (Post-Documentation) + Based on problem type detected, automatically invoke applicable agents: + - **performance_issue** → `performance-oracle` + - **security_issue** → `security-sentinel` + - **database_issue** → `data-integrity-guardian` + - **test_failure** → `cora-test-reviewer` + - Any code-heavy issue → `kieran-rails-reviewer` + `code-simplicity-reviewer` + +## What It Captures + +- **Problem symptom**: Exact error messages, observable behavior +- **Investigation steps tried**: What didn't work and why +- **Root cause analysis**: Technical explanation +- **Working solution**: Step-by-step fix with code examples +- **Prevention strategies**: How to avoid in future +- **Cross-references**: Links to related issues and docs + +## Preconditions + + + + Problem has been solved (not in-progress) + + + Solution has been verified working + + + Non-trivial problem (not simple typo or obvious error) + + + +## What It Creates + +**Organized documentation:** + +- File: `docs/solutions/[category]/[filename].md` + +**Categories auto-detected from problem:** + +- build-errors/ +- test-failures/ +- runtime-errors/ +- performance-issues/ +- database-issues/ +- security-issues/ +- ui-bugs/ +- integration-issues/ +- logic-errors/ + +## Success Output + +``` +✓ Parallel documentation generation complete + +Primary Subagent Results: + ✓ Context Analyzer: Identified performance_issue in brief_system + ✓ Solution Extractor: Extracted 3 code fixes + ✓ Related Docs Finder: Found 2 related issues + ✓ Prevention Strategist: Generated test cases + ✓ Category Classifier: docs/solutions/performance-issues/ + ✓ Documentation Writer: Created complete markdown + +Specialized Agent Reviews (Auto-Triggered): + ✓ performance-oracle: Validated query optimization approach + ✓ kieran-rails-reviewer: Code examples meet Rails standards + ✓ code-simplicity-reviewer: Solution is appropriately minimal + ✓ every-style-editor: Documentation style verified + +File created: +- docs/solutions/performance-issues/n-plus-one-brief-generation.md + +This documentation will be searchable for future reference when similar +issues occur in the Email Processing or Brief System modules. + +What's next? +1. Continue workflow (recommended) +2. Link related documentation +3. Update other references +4. View documentation +5. Other +``` + +## The Compounding Philosophy + +This creates a compounding knowledge system: + +1. First time you solve "N+1 query in brief generation" → Research (30 min) +2. Document the solution → docs/solutions/performance-issues/n-plus-one-briefs.md (5 min) +3. Next time similar issue occurs → Quick lookup (2 min) +4. Knowledge compounds → Team gets smarter + +The feedback loop: + +``` +Build → Test → Find Issue → Research → Improve → Document → Validate → Deploy + ↑ ↓ + └──────────────────────────────────────────────────────────────────────┘ +``` + +**Each unit of engineering work should make subsequent units of work easier—not harder.** + +## Auto-Invoke + + - "that worked" - "it's fixed" - "working now" - "problem solved" + + Use /compound [context] to document immediately without waiting for auto-detection. + +## Routes To + +`compound-docs` skill + +## Applicable Specialized Agents + +Based on problem type, these agents can enhance documentation: + +### Code Quality & Review +- **kieran-rails-reviewer**: Reviews code examples for Rails best practices +- **code-simplicity-reviewer**: Ensures solution code is minimal and clear +- **pattern-recognition-specialist**: Identifies anti-patterns or repeating issues + +### Specific Domain Experts +- **performance-oracle**: Analyzes performance_issue category solutions +- **security-sentinel**: Reviews security_issue solutions for vulnerabilities +- **cora-test-reviewer**: Creates test cases for prevention strategies +- **data-integrity-guardian**: Reviews database_issue migrations and queries + +### Enhancement & Documentation +- **best-practices-researcher**: Enriches solution with industry best practices +- **every-style-editor**: Reviews documentation style and clarity +- **framework-docs-researcher**: Links to Rails/gem documentation references + +### When to Invoke +- **Auto-triggered** (optional): Agents can run post-documentation for enhancement +- **Manual trigger**: User can invoke agents after /compound completes for deeper review + +## Related Commands + +- `/research [topic]` - Deep investigation (searches docs/solutions/ for patterns) +- `/plan` - Planning workflow (references documented solutions) diff --git a/plugins/compounding-engineering/skills/codify-docs/SKILL.md b/plugins/compounding-engineering/skills/compound-docs/SKILL.md similarity index 99% rename from plugins/compounding-engineering/skills/codify-docs/SKILL.md rename to plugins/compounding-engineering/skills/compound-docs/SKILL.md index 63232f1..32dede5 100644 --- a/plugins/compounding-engineering/skills/codify-docs/SKILL.md +++ b/plugins/compounding-engineering/skills/compound-docs/SKILL.md @@ -1,5 +1,5 @@ --- -name: codify-docs +name: compound-docs description: Capture solved problems as categorized documentation with YAML frontmatter for fast lookup allowed-tools: - Read # Parse conversation context @@ -11,7 +11,7 @@ preconditions: - Solution has been verified working --- -# codify-docs Skill +# compound-docs Skill **Purpose:** Automatically document solved problems to build searchable institutional knowledge with category-based organization (enum-validated problem types). @@ -348,7 +348,7 @@ Action: ## Integration Points **Invoked by:** -- /codify command (primary interface) +- /compound command (primary interface) - Manual invocation in conversation after solution confirmed - Can be triggered by detecting confirmation phrases like "that worked", "it's fixed", etc. diff --git a/plugins/compounding-engineering/skills/codify-docs/assets/critical-pattern-template.md b/plugins/compounding-engineering/skills/compound-docs/assets/critical-pattern-template.md similarity index 100% rename from plugins/compounding-engineering/skills/codify-docs/assets/critical-pattern-template.md rename to plugins/compounding-engineering/skills/compound-docs/assets/critical-pattern-template.md diff --git a/plugins/compounding-engineering/skills/codify-docs/assets/resolution-template.md b/plugins/compounding-engineering/skills/compound-docs/assets/resolution-template.md similarity index 100% rename from plugins/compounding-engineering/skills/codify-docs/assets/resolution-template.md rename to plugins/compounding-engineering/skills/compound-docs/assets/resolution-template.md diff --git a/plugins/compounding-engineering/skills/codify-docs/references/yaml-schema.md b/plugins/compounding-engineering/skills/compound-docs/references/yaml-schema.md similarity index 100% rename from plugins/compounding-engineering/skills/codify-docs/references/yaml-schema.md rename to plugins/compounding-engineering/skills/compound-docs/references/yaml-schema.md diff --git a/plugins/compounding-engineering/skills/codify-docs/schema.yaml b/plugins/compounding-engineering/skills/compound-docs/schema.yaml similarity index 100% rename from plugins/compounding-engineering/skills/codify-docs/schema.yaml rename to plugins/compounding-engineering/skills/compound-docs/schema.yaml