compound-docs

Solid

Capture solved problems as categorized documentation with YAML frontmatter for fast lookup

AI & Automation 448 stars 121 forks Updated today NOASSERTION

Install

View on GitHub

Quality Score: 82/100

Stars 20%
88
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# compound-docs Skill **Purpose:** Automatically document solved problems to build searchable institutional knowledge with category-based organization (enum-validated problem types). ## Overview This skill captures problem solutions immediately after confirmation, creating structured documentation that serves as a searchable knowledge base for future sessions. **Organization:** Single-file architecture - each problem documented as one markdown file in its symptom category directory (e.g., `docs/solutions/performance-issues/n-plus-one-briefs.md`). Files use YAML frontmatter for metadata and searchability. --- <critical_sequence name="documentation-capture" enforce_order="strict"> ## 7-Step Process <step number="1" required="true"> ### Step 1: Detect Confirmation **Auto-invoke after phrases:** - "that worked" - "it's fixed" - "working now" - "problem solved" - "that did it" **OR manual:** `/doc-fix` command **Non-trivial problems only:** - Multiple investigation attempts needed - Tricky debugging that took time - Non-obvious solution - Future sessions would benefit **Skip documentation for:** - Simple typos - Obvious syntax errors - Trivial fixes immediately corrected </step> <step number="2" required="true" depends_on="1"> ### Step 2: Gather Context Extract from conversation history: **Required information:** - **Module name**: Which module or component had the problem - **Symptom**: Observable error/behavior (exact error messages) - **Investigation attempts...

Details

Author
davekilleen
Repository
davekilleen/Dex
Created
6 months ago
Last Updated
today
Language
Python
License
NOASSERTION

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category