compound-docs

Capture solved problems into categorized markdown documents with validated YAML frontmatter.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/adamfeldman/compound-workflows --skill compound-docs-adamfeldman
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/adamfeldman/compound-workflows/tree/main/plugins/compound-workflows/skills/compound-docs
Command: npx skills add https://github.com/adamfeldman/compound-workflows --skill compound-docs-adamfeldman

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of capturing solved problems as categorized documentation, building a searchable knowledge base and preventing future occurrences of the same issues.

Core Features & Use Cases

  • Automatic Documentation: Captures solutions to problems immediately after they are confirmed as fixed.
  • Categorized Knowledge Base: Organizes documentation into specific symptom categories for easy retrieval.
  • YAML Frontmatter: Uses structured metadata for enhanced searchability and consistency.
  • Use Case: After debugging a complex performance issue in the Auth Service, this Skill automatically creates a detailed markdown document in the performance-issues category, including the root cause, solution, and prevention steps, making it instantly searchable for future reference.

Quick Start

Use the compound-docs skill to document the solution to the last problem discussed in the conversation.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I automatically document solved problems into a searchable knowledge base?

You can automatically document solved problems by capturing the context, classifying the issue, and organizing the solution into categorized markdown documents with validated YAML frontmatter. This creates a searchable institutional knowledge base.

Why use YAML frontmatter when creating markdown documentation for debugging issues?

YAML frontmatter provides structured metadata for enhanced searchability and consistency in your knowledge base. It enforces a defined schema for metadata consistency, ensuring solved problems are categorized correctly for easy retrieval.

How do I categorize performance issues and other debugging solutions in markdown?

You categorize performance issues by extracting context from the solved problem and organizing the solution into specific symptom categories. The Skill creates a detailed markdown document including the root cause, solution, and prevention steps.

Can I use automated documentation without installing external dependencies?

Yes, you can use this automated documentation Skill without external dependencies. It requires no packages or libraries and operates independently to capture solutions into markdown documents with strict YAML frontmatter validation.

What is the best way to prevent recurring issues in a software engineering team?

The best way to prevent recurring issues is to automate the creation of a categorized knowledge base. Capturing root cause, solution, and prevention steps into searchable markdown documents immediately after a problem is fixed ensures future reference.

Are there limitations when using strict YAML schemas for problem categorization?

The main limitation of using a strict YAML schema for problem categorization is that it requires strict adherence to the defined metadata structure. Solutions that do not fit the predefined symptom categories may require manual schema adjustments.