compound-docs

Capture solved problems as categorized markdown documentation with validated YAML frontmatter.

Updated Jan 23, 2026
One-click install
npx skills add https://github.com/stephschofield/beth --skill compound-docs-stephschofield
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/stephschofield/beth/tree/main/.github/skills/compound-docs
Command: npx skills add https://github.com/stephschofield/beth --skill compound-docs-stephschofield

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve? Solved debugging sessions and non-trivial fixes are often lost once a conversation ends, forcing teams to re-investigate the same issues. This Skill turns confirmed solutions into structured, searchable documentation so institutional knowledge accumulates instead of evaporating. ## Core Features & Use Cases - Automatic capture on confirmation: Detects phrases like "that worked" or "it's fixed" and documents the solution while context is fresh. - Schema-validated frontmatter: Every doc is validated against schema.yaml with enum-checked fields (problem_type, component, root_cause, severity) before any file is written. - Category-based organization: Files are routed into docs/solutions/ subdirectories (e.g., performance-issues, build-errors) with sanitized, dated filenames. - Cross-referencing and pattern promotion: Links related issues and can promote recurring critical patterns into a Required Reading file for all subagents. - Use Case: After fixing an N+1 query in a Rails Brief System, the skill creates docs/solutions/performance-issues/n-plus-one-brief-generation-BriefSystem-20251110.md with validated metadata, code examples, and prevention guidance. ## Quick Start After confirming a fix worked, ask the agent to document this solution using the compound-docs skill.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I document a solved bug automatically after fixing it?▼

Confirm the fix with a phrase like "that worked" or invoke the /doc-fix command. The skill gathers context from the conversation, validates YAML frontmatter against schema.yaml, and writes a categorized markdown file under docs/solutions/.

What YAML fields are required for solution documentation?▼

Required fields are module, date, problem_type, component, symptoms, root_cause, resolution_type, and severity. Enum fields must match schema.yaml values exactly, and symptoms must be an array of 1-5 observable items.

How are solution documents organized into categories?▼

The problem_type enum maps to a directory, such as performance_issue to docs/solutions/performance-issues/ or build_error to docs/solutions/build-errors/. Filenames follow a sanitized symptom-module-date format.

What happens when a similar issue already exists in the docs?▼

The skill searches docs/solutions/ for matches and asks whether to create a new doc with a cross-reference, update the existing doc, or take another action. It waits for your choice before proceeding.

When should a solution be promoted to critical patterns?▼

Promote it when the mistake recurs across modules, the solution is non-obvious but mandatory, or it is a foundational requirement. The skill never auto-promotes; you choose Option 2 in the post-documentation menu.