Engineering
troubleshooting-docs avatar

troubleshooting-docs

Automates the documentation of solved technical issues using YAML frontmatter, categorized directories, and institutional knowledge indexing for JUCE plugin development.

Introduction

The troubleshooting-docs skill functions as an automated institutional memory engine for the Plugin Freedom System. It is designed for software developers and audio engineers working within the JUCE framework who need to capture debugging insights immediately upon reaching a resolution. By monitoring conversation triggers like 'it's fixed' or '/doc-fix', the skill automatically extracts technical context—such as symptom descriptions, root causes, OS versions, and specific code adjustments—and organizes them into a searchable markdown-based knowledge base. This eliminates the 'forgetting curve' of complex build failures, GUI crashes, or DSP algorithm errors by ensuring every solved problem serves as a reusable template for future development cycles.

  • Automatically captures and sanitizes problem symptoms, root causes, and technical solutions for quick retrieval.

  • Enforces strict YAML frontmatter schemas to ensure documentation consistency and enum-based categorization.

  • Performs automated grep-based searches of existing documentation to prevent redundant entries and suggest relevant cross-references.

  • Integrates with pattern detection systems to identify recurring critical issues, enabling proactive architectural improvements.

  • Supports systematic documentation of build failures, API misuse, stage-based implementation errors, and runtime diagnostics.

  • Trigger the documentation flow using natural language confirmations or the /doc-fix command once a problem is verified.

  • Input requirements include precise error logs, JUCE version, specific plugin stage, and actionable remediation steps.

  • The system validates all documentation against predefined enum schemas before saving to directory-categorized markdown files.

  • Users are prompted to perform bidirectional cross-referencing if similar issues are detected, strengthening the network of institutional knowledge.

  • This tool is constrained to solved, verified issues; it skips trivial fixes like simple syntax errors to maintain a high-signal, professional knowledge base.

Repository Stats

Stars
183
Forks
66
Open Issues
4
Language
HTML
Default Branch
main
Sync Status
Idle
Last Synced
Apr 29, 2026, 02:19 PM
View on GitHub