compound-docs

Captures solved technical problems and generates categorized Markdown documents with validated YAML frontmatter.

11|Updated Jun 19, 2013
One-click install
npx skills add https://github.com/MadBomber/experiments --skill compound-docs-madbomber
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/MadBomber/experiments/tree/main/ai_misc/skills/compound-docs
Command: npx skills add https://github.com/MadBomber/experiments --skill compound-docs-madbomber

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 documenting solved technical problems, transforming conversational solutions into searchable, categorized Markdown files with structured YAML frontmatter.

Core Features & Use Cases

  • Automated Documentation: Captures problem context, root cause, and solution from conversations.
  • Categorized Storage: Organizes documentation into relevant directories based on problem type.
  • Searchable Knowledge Base: Creates YAML frontmatter for fast lookups and future reference.
  • Use Case: After debugging a complex performance issue in the 'Brief System' module, you can use this skill to automatically create a detailed documentation entry in docs/solutions/performance-issues/ that future developers can easily find and learn from.

Quick Start

Use the /doc-fix command after a problem has been solved to document it.

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 technical problems from conversations automatically?

To document solved technical problems automatically, you can use a confirmation phrase or the /doc-fix command to capture the problem context, root cause, and solution from your conversation and generate a Markdown file.

How do I generate Markdown documentation with validated YAML frontmatter for a troubleshooting fix?

Generating Markdown documentation with validated YAML frontmatter involves capturing the problem context and solution, validating the data against a YAML schema, and creating a categorized file with structured metadata for fast lookups.

What is the best way to build a searchable knowledge base from debugging sessions?

The best way to build a searchable knowledge base from debugging sessions is to transform conversational solutions into categorized Markdown files with structured YAML frontmatter, enabling fast future reference and lookups.

Can I organize code documentation into categorized directories based on problem type?

Yes, you can organize code documentation into categorized directories based on problem type. The process automatically categorizes technical solutions into relevant directories such as performance-issues during file creation.

Does this automated documentation process support cross-referencing existing entries?

Yes, the automated documentation process supports optional cross-referencing and pattern promotion. It checks existing documentation before file creation to optionally link related solutions and promote recurring patterns.

When should I not use an automated Markdown documentation generator for problem solving?

You should not use an automated Markdown documentation generator when a problem remains unsolved or lacks a clear root cause, as the process specifically requires captured conversational solutions and validated context to generate useful entries.