Files
claude-engineering-plugin/plugins/compounding-engineering/skills/codify-docs/references/yaml-schema.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

3.0 KiB

YAML Frontmatter Schema

See .claude/skills/codify-docs/schema.yaml for the complete schema specification.

Required Fields

  • module (string): Module name (e.g., "EmailProcessing") or "CORA" for system-wide issues
  • date (string): ISO 8601 date (YYYY-MM-DD)
  • problem_type (enum): One of [build_error, test_failure, runtime_error, performance_issue, database_issue, security_issue, ui_bug, integration_issue, logic_error, developer_experience, workflow_issue, best_practice, documentation_gap]
  • component (enum): One of [rails_model, rails_controller, rails_view, service_object, background_job, database, frontend_stimulus, hotwire_turbo, email_processing, brief_system, assistant, authentication, payments, development_workflow, testing_framework, documentation, tooling]
  • symptoms (array): 1-5 specific observable symptoms
  • root_cause (enum): One of [missing_association, missing_include, missing_index, wrong_api, scope_issue, thread_violation, async_timing, memory_leak, config_error, logic_error, test_isolation, missing_validation, missing_permission, missing_workflow_step, inadequate_documentation, missing_tooling, incomplete_setup]
  • resolution_type (enum): One of [code_fix, migration, config_change, test_fix, dependency_update, environment_setup, workflow_improvement, documentation_update, tooling_addition, seed_data_update]
  • severity (enum): One of [critical, high, medium, low]

Optional Fields

  • rails_version (string): Rails version in X.Y.Z format
  • tags (array): Searchable keywords (lowercase, hyphen-separated)

Validation Rules

  1. All required fields must be present
  2. Enum fields must match allowed values exactly (case-sensitive)
  3. symptoms must be YAML array with 1-5 items
  4. date must match YYYY-MM-DD format
  5. rails_version (if provided) must match X.Y.Z format
  6. tags should be lowercase, hyphen-separated

Example

---
module: Email Processing
date: 2025-11-12
problem_type: performance_issue
component: rails_model
symptoms:
  - "N+1 query when loading email threads"
  - "Brief generation taking >5 seconds"
root_cause: missing_include
rails_version: 7.1.2
resolution_type: code_fix
severity: high
tags: [n-plus-one, eager-loading, performance]
---

Category Mapping

Based on problem_type, documentation is filed in:

  • build_errordocs/solutions/build-errors/
  • test_failuredocs/solutions/test-failures/
  • runtime_errordocs/solutions/runtime-errors/
  • performance_issuedocs/solutions/performance-issues/
  • database_issuedocs/solutions/database-issues/
  • security_issuedocs/solutions/security-issues/
  • ui_bugdocs/solutions/ui-bugs/
  • integration_issuedocs/solutions/integration-issues/
  • logic_errordocs/solutions/logic-errors/
  • developer_experiencedocs/solutions/developer-experience/
  • workflow_issuedocs/solutions/workflow-issues/
  • best_practicedocs/solutions/best-practices/
  • documentation_gapdocs/solutions/documentation-gaps/