Files
claude-engineering-plugin/plugins/compounding-engineering/commands/workflows/codify.md
Kieran Klaassen 8cc99ab483 feat(plugin): reorganize compounding-engineering v2.0.0
Major restructure of the compounding-engineering plugin:

## Agents (24 total, now categorized)
- review/ (10): architecture-strategist, code-simplicity-reviewer,
  data-integrity-guardian, dhh-rails-reviewer, kieran-rails-reviewer,
  kieran-python-reviewer, kieran-typescript-reviewer,
  pattern-recognition-specialist, performance-oracle, security-sentinel
- research/ (4): best-practices-researcher, framework-docs-researcher,
  git-history-analyzer, repo-research-analyst
- design/ (3): design-implementation-reviewer, design-iterator,
  figma-design-sync
- workflow/ (6): bug-reproduction-validator, every-style-editor,
  feedback-codifier, lint, pr-comment-resolver, spec-flow-analyzer
- docs/ (1): ankane-readme-writer

## Commands (15 total)
- Moved workflow commands to commands/workflows/ subdirectory
- Added: changelog, create-agent-skill, heal-skill, plan_review,
  prime, reproduce-bug, resolve_parallel, resolve_pr_parallel

## Skills (11 total)
- Added: andrew-kane-gem-writer, codify-docs, create-agent-skills,
  dhh-ruby-style, dspy-ruby, every-style-editor, file-todos,
  frontend-design, git-worktree, skill-creator
- Kept: gemini-imagegen

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-24 11:42:18 -08:00

6.7 KiB

name, description, argument-hint
name description argument-hint
codify Document a recently solved problem for the knowledge base [optional: brief context about the fix]

/codify

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.

Usage

/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
  • 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_issueperformance-oracle
  • security_issuesecurity-sentinel
  • database_issuedata-integrity-guardian
  • test_failurecora-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

<auto_invoke> <trigger_phrases> - "that worked" - "it's fixed" - "working now" - "problem solved" </trigger_phrases>

<manual_override> Use /codify [context] to document immediately without waiting for auto-detection. </manual_override> </auto_invoke>

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
  • /research [topic] - Deep investigation (searches docs/solutions/ for patterns)
  • /plan - Planning workflow (references documented solutions)