compound-docs

Solid

Document solved problems for team reuse. Provides process knowledge for /ia-compound. Use when documenting a resolved issue, writing up lessons learned, capturing a post-mortem, adding to the knowledge base, or building searchable institutional knowledge after debugging.

AI & Automation 41 stars 8 forks Updated 3 days ago MIT

Install

View on GitHub

Quality Score: 86/100

Stars 20%
54
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
80
License 10%
100
Description 5%
100

Skill Content

# compound-docs ## Process Single-file architecture -- one markdown file per problem in its symptom category directory (e.g., `docs/solutions/performance-issues/n-plus-one-briefs.md`), with YAML frontmatter for metadata. Follow the 7-step documentation capture process. For full details, see [documentation-process.md](./references/documentation-process.md). 1. **Detect confirmation** -- Auto-invoke after "that worked", "it's fixed", etc. Skip trivial fixes. 2. **Gather context** -- Extract module, symptom, investigation attempts, root cause, solution, prevention. BLOCK if critical context missing. 3. **Check existing docs** -- Search `docs/solutions/` for similar issues. If found, offer: new doc with cross-reference, update existing, or other. 4. **Generate filename** -- Format: `[sanitized-symptom]-[module]-[YYYYMMDD].md` 5. **Validate YAML** -- Run [validate-frontmatter.sh](./scripts/validate-frontmatter.sh) against the file. If invalid, fix the frontmatter and re-run until it passes. 6. **Create documentation** -- Write file to `docs/solutions/[category]/[filename].md` using [resolution-template.md](./assets/resolution-template.md). 7. **Cross-reference** -- Link related issues. Detect critical patterns (3+ similar issues). --- ## Decision Menu After successful documentation, present and WAIT for user response: ``` Solution documented File created: - docs/solutions/[category]/[filename].md What's next? 1. Continue workflow (recommended) 2. Add to Required Reading ...

Details

Author
iliaal
Repository
iliaal/ai-skills
Created
6 months ago
Last Updated
3 days ago
Language
Shell
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category