skills.rest
andrewhwaller
andrewhwallerCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

compound-docs

Generate categorized markdown solution entries with YAML frontmatter.

Updated May 20, 2022
Search Tags:#automation#documentation#problem-solving#yaml-frontmatter#knowledge-base#docs-generation
One-click install
npx skills add https://github.com/andrewhwaller/dotfiles --skill compound-docs-andrewhwaller
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/andrewhwaller/dotfiles/tree/main/opencode/skills/compound-docs
Command: npx skills add https://github.com/andrewhwaller/dotfiles --skill compound-docs-andrewhwaller

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps teams turn solved problems into organized, searchable documentation by automatically generating category-based markdown files with YAML frontmatter.

Core Features & Use Cases

  • Automatically capture problem details after confirmation
  • Organize documentation by problem_type category directories
  • Produce a reusable template with standardized metadata for quick lookup

Quick Start

Provide the resolved context and run the documentation workflow to create a new entry.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I generate searchable documentation for solved problems?▼

To generate searchable documentation for solved problems, provide the resolved context to trigger the workflow, which parses the conversation and creates categorized markdown entries with YAML frontmatter for fast retrieval.

How does YAML frontmatter help organize a knowledge base?▼

YAML frontmatter organizes a knowledge base by embedding machine-readable metadata into markdown files, enabling consistent archival and fast lookup of solutions categorized by problem type.

What is the best way to automate docs-generation for a team knowledge base?▼

Automating docs-generation for a team knowledge base is best handled by automatically capturing problem details after confirmation and organizing markdown files into category directories using standardized templates.

Can I use markdown files with YAML frontmatter for problem-solving archival?▼

Yes, you can use markdown files with YAML frontmatter for problem-solving archival by structuring resolved contexts into machine-readable entries under docs/solutions, organized by problem type.

When do I need to create standardized templates for docs-generation?▼

You need to create standardized templates for docs-generation when new solutions are confirmed and require consistent archival across categories to ensure quick lookup and retrieval within the knowledge base.

Does automated docs-generation require parsing conversation context?▼

Yes, automated docs-generation requires parsing conversation context to extract resolved problem details, generate standardized metadata, and create categorized markdown entries for the knowledge base.

Related Skills

Explore More Content & Communication Skills→
iliaaliliaal

compound-docs

Captures solved problems as categorized documentation with YAML frontmatter.

Community
Intermediate
majesticlabs-devmajesticlabs-dev
47

fix-reporter

Capture solved problems as categorized Markdown docs with YAML frontmatter.

Official
Advanced
semaes111semaes111

Asistente para la Redacción de Demandas Tributarias

Draft Spanish contencioso-administrative tax demands with legal citations.

Community
Advanced
8b-is8b-is

compound-docs

Generate categorized Markdown solution notes with YAML frontmatter.

Official
Advanced