compound-docs

Capture solved Ruby on Rails problems as categorized YAML-validated documentation.

5|Updated Mar 27, 2026
One-click install
npx skills add https://github.com/barkleesanders/claude-code-starter --skill compound-docs-barkleesanders
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/barkleesanders/claude-code-starter/tree/main/skills/compound-docs
Command: npx skills add https://github.com/barkleesanders/claude-code-starter --skill compound-docs-barkleesanders

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Engineering teams lose hours of productivity re-debugging issues that were already solved but never documented, as institutional knowledge is tied to individual conversation history instead of a shared, searchable knowledge base.

Core Features & Use Cases

  • Validated Structured Documentation: Automatically generates categorized problem docs with strict YAML frontmatter validation against enum schemas for problem type, component, root cause, and severity, ensuring consistent, searchable records.
  • 7-Step Capture Workflow: Guides users through confirmation detection, context gathering, duplicate doc checking, filename generation, validation gating, file creation, and cross-referencing for non-trivial solved problems.
  • Critical Pattern Promotion: Identifies common, high-severity issues and lets users promote them to required reading for team-wide enforcement, preventing repeated mistakes. Use case: After your team fixes a tricky N+1 query bug in the Brief System, this skill automatically creates a categorized, searchable doc with all context, error messages, and the fix, so no one else has to spend hours debugging the same issue.

Quick Start

Use the compound-docs skill to document the N+1 query issue we just fixed in the Brief System.

Frequently Asked Questions about compound-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I document solved Rails debugging issues to preserve team knowledge?

Document solved Rails debugging issues by capturing them as structured files with validated YAML frontmatter for problem type, component, root cause, and severity. This ensures institutional knowledge is saved in a searchable, categorized knowledge base instead of isolated chat histories.

Can I enforce team-wide reading for critical engineering workflow problems?

Yes, you can promote common, high-severity engineering workflow problems to required reading. This feature flags critical patterns for team-wide enforcement, preventing repeated mistakes and ensuring everyone reviews the documented solutions to tricky issues like N+1 query bugs.

How does YAML frontmatter validation work for technical documentation?

YAML frontmatter validation enforces strict schemas using enums for problem type, component, root cause, and severity. This gating mechanism ensures consistent, searchable technical documentation records by rejecting files that do not match the predefined categorization structure.

What's the best way to track recurring Ruby on Rails performance issues?

Track recurring Ruby on Rails performance issues by capturing them as categorized documentation with enforced YAML validation. Cross-referencing similar issues and promoting high-severity patterns to required reading prevents teams from spending hours re-debugging the same performance problems.