skills.rest
Hff1230
Hff1230COMMUNITY
Explore all skills by this author →
GitHub

compound-docs

Automate documenting solved issues as categorized YAML-frontmatter Markdown files.

Updated Dec 21, 2023
Search Tags:#documentation#yaml-frontmatter#knowledge-base#docs-architecture#issue-recording#searchable-docs
One-click install
npx skills add https://github.com/Hff1230/FFNotes --skill compound-docs-hff1230
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/Hff1230/FFNotes/tree/main/AI%E5%BA%93/Skill/compound-engineering-zh/skills/compound-docs
Command: npx skills add https://github.com/Hff1230/FFNotes --skill compound-docs-hff1230

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

It records solved problems as categorized Markdown documents annotated with YAML frontmatter to enable fast searching and structured knowledge retrieval.

Core Features & Use Cases

  • Single-file per issue: each resolved problem is captured as a Markdown document under docs/solutions/<category>/<issue>.md.
  • YAML frontmatter for metadata: captures module, date, problem_type, symptoms, root_cause, resolution_type, severity, and other optional fields for precise filtering.
  • Searchable knowledge base: metadata enables rapid lookup and reuse in future conversations or analyses.

Quick Start

Create a new Markdown file under docs/solutions/<category>/<issue>.md and begin with a YAML frontmatter containing the required fields, followed by a concise narrative.

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

Document solved issues by creating Markdown files under docs/solutions/<category>/ with YAML frontmatter capturing module, date, problem_type, symptoms, root_cause, resolution_type, and severity for structured retrieval. A concise narrative body follows the frontmatter.

What metadata fields are required for YAML frontmatter in issue documentation?▼

Required YAML frontmatter fields for issue documentation include module, date, problem_type, component, symptoms, root_cause, resolution_type, and severity. Optional tags can be added for additional categorization and filtering.

How should I organize resolved problem knowledge base files across different modules?▼

Organize resolved problem knowledge base files by storing each issue as a single Markdown document under docs/solutions/<category>/<issue>.md, categorizing by problem type or module for quick retrieval across teams.

Can I use searchable YAML frontmatter docs for team knowledge retrieval?▼

YAML frontmatter docs enable team knowledge retrieval by capturing structured metadata for rapid lookup. Teams maintaining centralized knowledge bases can filter by module, severity, or problem_type to reuse solutions in future conversations.

What's the best way to structure a knowledge base of resolved problems for fast searching?▼

Structure resolved problem knowledge bases using single-file Markdown documents with YAML frontmatter metadata. This approach enables precise filtering by fields like root_cause and resolution_type, allowing rapid lookup across categorized solution directories.

Do I need any dependencies to create categorized Markdown documentation for issue tracking?▼

No dependencies are required to create categorized Markdown documentation for issue tracking. Files are standard Markdown with YAML frontmatter, stored under docs/solutions/<category>/ directories without external tools or frameworks.

Related Skills

CristoVenturesCristoVentures
2

compound-docs

Generate categorized Markdown files with YAML frontmatter for solved problems.

Official
Intermediate
abuilesabuiles
11

compound-docs

Document solved problems into categorized YAML-frontmatter markdown notes.

Community
Advanced
CuriousCrow123CuriousCrow123

compound-docs

Generate categorized Markdown documents with YAML frontmatter for solved problems.

Community
Advanced
mistakeknotmistakeknot
3

interknow

Manage durable knowledge entries with provenance tracking and semantic retrieval.

Community
Intermediate