compound-docs

compound-docs Skill

Purpose: Automatically document solved problems to build searchable institutional knowledge with category-based organization (enum-validated problem types).

Learnings entry (compound)

Append a structured learning entry to docs/learnings.md in the project repo.

Inputs

• Stage (explore = discovery/insights; shape/develop/review/release/other).
• Title.
• Context links (PR, issue, docs paths).
• Summary and what changed.
• Root cause, fix, prevention.
• Verification evidence (required if code-touching).

Outputs

• Updated docs/learnings.md (append-only).

Steps

1. Open the project repo docs/learnings.md.
2. Add a new entry under the matching stage heading.
3. Include required fields and verification evidence if code-touching.
4. Keep history append-only.

Verification

• Entry includes date, stage, summary, root cause, fix, prevention, verification, and links.

Go/No-Go

• GO if entry is complete and appended under correct stage.
• NO-GO if required fields are missing.

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.

---

7-Step Process

Step 1: Detect Confirmation

Auto-invoke after phrases:

• "that worked"
• "it's fixed"
• "working now"
• "problem solved"
• "that did it"

OR manual: invoke compound-docs skill

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 2: Gather Context

Extract from conversation history: