compound-docs

Document solved problems into categorized YAML-frontmatter files under docs/solutions/.

14|1|Updated Dec 29, 2011
One-click install
npx skills add https://github.com/doitian/dotfiles-public --skill compound-docs-doitian
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/doitian/dotfiles-public/tree/main/ai/workflows/compound-engineering/skills/compound-docs
Command: npx skills add https://github.com/doitian/dotfiles-public --skill compound-docs-doitian

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Automatically documents solved problems into categorized, YAML-frontmatter files to enable fast lookup and onboarding.

Core Features & Use Cases

  • Automatically document solved problems immediately after confirmation, creating a structured, searchable record.
  • Organize docs by symptom category into docs/solutions/[category]/[filename] to maintain clear categorization.
  • Use YAML frontmatter for metadata and cross-referencing to support quick lookup and analytics.
  • Maintain a single-file-per-issue approach to keep documentation concise and navigable.

Quick Start

Confirm a solution to automatically generate a categorized documentation file under docs/solutions/[category].

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 problems into categorized files for fast lookup?▼

Document solved problems by automatically generating categorized, YAML-frontmatter files under docs/solutions/[category]/ to enable structured metadata and fast retrieval. Each issue is saved as a single, category-labeled file immediately after solution confirmation.

When do I need YAML frontmatter for my troubleshooting knowledge base?▼

You need YAML frontmatter for your troubleshooting knowledge base when you want to enforce structured metadata, apply category mapping, and establish cross-references to support efficient retrieval and analytics across your documented solutions.

What is the best way to organize troubleshooting documentation by symptom category?▼

The best way to organize troubleshooting documentation is using a single-file-per-issue approach, storing records under docs/solutions/[category]/[filename] to maintain clear categorization and keep documentation concise and navigable for onboarding.

Does this documentation approach require manual categorization for every solved issue?▼

No, this documentation approach does not require manual categorization for every solved issue. It automatically maps symptoms to categories and generates the structured file with cross-references immediately after you confirm a solution.

How do cross-references work in a single-file-per-issue knowledge base?▼

Cross-references in a single-file-per-issue knowledge base work by embedding links within the YAML frontmatter metadata. This connects related troubleshooting documents across different category directories to support quick lookup and knowledge sharing.