compound-docs

Create categorized Markdown documents with YAML frontmatter for solved issues.

25|15|Updated Aug 2, 2021
One-click install
npx skills add https://github.com/JesusFilm/core --skill compound-docs-jesusfilm
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/JesusFilm/core/tree/main/.claude/skills/compound-docs
Command: npx skills add https://github.com/JesusFilm/core --skill compound-docs-jesusfilm

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Automatically capture and categorize solved problems as YAML-frontmatter documents for fast lookup.

Core Features & Use Cases

  • Automatically create a categorized Markdown document per solved issue
  • Store solved-problem docs under docs/solutions/[category] with a consistent frontmatter schema
  • Enable cross-referencing, templates, and future pattern extraction

Quick Start

Run the compound-docs skill immediately after solution confirmation to generate a categorized documentation file under docs/solutions.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I automatically create documentation for solved problems?

Documenting solved problems with YAML frontmatter provides a consistent metadata schema for fast lookup and categorization. It enables cross-referencing and future pattern extraction across your Markdown knowledge base.

How do I organize troubleshooting documentation by symptom category?

Yes, you can attach optional references and assets to your problem documentation files. The skill supports including these linked components alongside the YAML frontmatter Markdown files for additional context.

Do I need to verify a problem is solved before documenting it?

Yes, you should confirm and verify a problem is solved before documenting it. The skill is designed to run immediately after solution confirmation to capture the verified resolution accurately.

How do I validate YAML frontmatter in Markdown documentation?

You validate YAML frontmatter in Markdown documentation using the built-in validation guidance provided by the skill. This ensures your problem documentation maintains a consistent frontmatter schema for reliable parsing.