compound-docs

Generate categorized Markdown solution docs with YAML frontmatter from problem metadata.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the documentation of solved problems into a structured, searchable knowledge base using YAML frontmatter for metadata and a standardized resolution template.

Core Features & Use Cases

  • Automated problem documentation: capture context, root cause, and solution after validation.
  • Category-based organization: stores docs under docs/solutions/<category> with frontmatter.
  • Reusable templates: uses assets/resolution-template.md to format entries and ensure consistency.

Quick Start

After confirming a solution, run the compound-docs skill to generate a documented entry. The resulting Markdown file will be placed in the appropriate docs/solutions category and structured with a standard frontmatter.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I automate documentation for solved problems using YAML frontmatter?

Automating documentation for solved problems involves capturing context, root cause, and solution metadata into YAML frontmatter. This process generates a single Markdown file per issue, storing it under a category derived from the problem type for a searchable knowledge base.

What is the best way to organize resolution docs into a categorized knowledge base?

Organizing resolution docs into a categorized knowledge base is achieved by storing each Markdown file under docs/solutions/<category>. The category is automatically derived from the problem type, ensuring standardized and searchable records across the documentation.

How do I use Markdown templates for consistent problem-solving documentation?

Using Markdown templates for consistent documentation requires placing a template in assets/resolution-template.md. The system applies this template after solution confirmation to format entries, ensuring every documented issue follows the same structure.

Do I need a schema to validate YAML frontmatter for my docs automation?

You need a schema to validate YAML frontmatter for docs automation. The process validates the generated frontmatter against a schema.yaml file, ensuring standardized metadata fields are present before storing the Markdown doc in the knowledge base.

When should I generate categorized documentation for a resolved issue?

You should generate categorized documentation for a resolved issue immediately after confirming the solution. Running the process at this point captures the context and metadata accurately, creating a permanent record in the solutions directory.