skills.rest
weorbitant
weorbitantOFFICIAL
Explore all skills by this author →
WebsiteGitHub

compound-docs

Document solved problems as categorized Markdown files with validated YAML frontmatter.

1|Updated Apr 13, 2026
Search Tags:#automation#documentation#yaml-frontmatter#knowledge-base#cross-reference
One-click install
npx skills add https://github.com/weorbitant/compound-engineering-feat-python-plugin --skill compound-docs-weorbitant
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/weorbitant/compound-engineering-feat-python-plugin/tree/main/skills/compound-docs
Command: npx skills add https://github.com/weorbitant/compound-engineering-feat-python-plugin --skill compound-docs-weorbitant

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Capture solved problems as categorized, searchable Markdown files with validated YAML frontmatter, enabling fast lookup and cross-reference across projects.

Core Features & Use Cases

  • Create a structured, location-aware documentation artifact for each solved problem under docs/solutions/<category>.
  • Validate frontmatter against the YAML schema and support cross-linking with related issues and patterns.
  • Drive reproducibility by providing templates and a 7-step process that ensures consistency across teams.

Quick Start

Document a solved problem by following the 7-step workflow to generate a docs/solution entry.

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 as Markdown files with YAML frontmatter?▼

Document solved problems as categorized Markdown files with validated YAML frontmatter by following a 7-step workflow that generates docs/solution entries under docs/solutions/<category>.

What is the best way to build a searchable knowledge base from solved issues?▼

Building a searchable knowledge base from solved issues involves categorizing Markdown files under docs/solutions/<category> with validated YAML frontmatter to drive reproducibility and ensure consistency across teams.

How does YAML frontmatter validation work for documentation entries?▼

YAML frontmatter validation checks your documentation entries against a predefined YAML schema, supporting cross-linking with related issues and patterns to ensure reproducibility and structural consistency.

Can I use cross-references to link related issues in my documentation?▼

Yes, you can use cross-references to link related issues and patterns. The validated YAML frontmatter supports cross-linking across projects to enable fast lookup of categorized solutions.

Do I need any external dependencies to automate documentation generation?▼

No external dependencies are required to automate documentation generation. The workflow operates independently to validate YAML frontmatter and output categorized Markdown files for your knowledge base.

When should I use a 7-step workflow for documentation automation?▼

Use the 7-step workflow for documentation automation when you need to enforce reproducibility and consistency across teams, ensuring every solved problem is captured as a structured, location-aware artifact.

Related Skills

Explore More Content & Communication Skills→
pulumipulumi
178

new-doc

Generate Pulumi documentation pages with YAML frontmatter and menu structure.

Official
Advanced
hemoryhemory

compound-docs

Capture solved technical problems into Markdown knowledge base entries with YAML frontmatter.

Community
Advanced
microsoftmicrosoft
2.9k

wiki-vitepress

Package wiki Markdown into a VitePress static site with dark theme and Mermaid diagrams.

Official
Advanced
granietgraniet
247

llm-wiki

Create and maintain interlinked markdown knowledge bases with linting and Obsidian integration.

Community
Advanced