compound-docs

Capture non-obvious engineering fixes as structured markdown learning documents.

2|Updated Mar 4, 2026
One-click install
npx skills add https://github.com/thesyntaxninja/syntaxninja-dojo --skill compound-docs-thesyntaxninja
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: compound-docs
Source: https://github.com/thesyntaxninja/syntaxninja-dojo/tree/main/skills/compound-docs
Command: npx skills add https://github.com/thesyntaxninja/syntaxninja-dojo --skill compound-docs-thesyntaxninja

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Capturing non-obvious fixes and insights is often ad hoc or forgotten, which causes repeated debugging effort and lost institutional knowledge. This Skill ensures important engineering learnings are proposed, reviewed, and stored in a consistent, scannable format so future teams can avoid the same pitfalls.

Core Features & Use Cases

  • Trigger detection: Recognizes language and signals that indicate a hard problem was solved (e.g., "finally figured it out", "that was tricky").
  • Propose then persist: Drafts a concise lesson with Problem, Root Cause, Solution, Key Insight, and References and asks the user for approval before writing to docs/learnings/<category>/<filename>.md.
  • Duplicate check & chaining: Checks existing learnings to avoid duplication, updates existing entries when appropriate, and chains to propose-skill-update when multiple learnings indicate a pattern.
  • Use cases: Recording a tricky bug fix, documenting a library workaround, capturing deployment or configuration lessons that required investigation.

Quick Start

Propose capturing the recent non-obvious fix as a lesson learned with a short Problem, Root Cause, Solution, Key Insight, and References and ask me to approve before saving.

Frequently Asked Questions about compound-docs

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

FAQPage Schema
How do I document non-obvious engineering solutions after debugging?

Capture engineering solutions by drafting a markdown file with sections for Problem, Root Cause, Solution, Key Insight, and References. The file is saved under docs/learnings/<category>/ so future teams can review and avoid repeating the same investigation.

What is the best way to capture lessons learned from tricky bug fixes?

The best way to capture lessons learned is by proposing a concise postmortem document with standardized sections for Problem, Root Cause, and Solution. It requires your approval before saving, ensuring only verified workarounds are stored in your knowledge base.

How do I avoid duplicate documentation when recording engineering workarounds?

Avoid duplicate documentation by checking existing entries before saving new learnings. The workflow identifies matching records, updates existing entries when appropriate, and flags recurring patterns to suggest broader skill updates rather than creating redundant files.

Can I automate knowledge capture for deployment and configuration issues?

Yes, you can automate knowledge capture for deployment and configuration issues. The workflow detects trigger phrases like 'finally figured it out' during or after investigations, automatically drafting a proposed lesson learned document for your review and approval before saving.

When should I create a postmortem document for a software engineering issue?

Create a postmortem document when a fix requires investigation or a workaround, specifically after resolving debugging, configuration, integration, performance, testing, or deployment issues. This ensures hard-won insights are captured rather than lost as ad hoc notes.