工程开发
troubleshooting-docs avatar

troubleshooting-docs

自动化记录已解决的技术问题,利用 YAML 前言、分类目录与结构化知识库,专为 JUCE 插件开发所设计。

简介

troubleshooting-docs 技能是 Plugin Freedom System 的自动化组织记忆引擎。它专为在 JUCE 框架内工作的软件开发人员和音频工程师所设计,旨在于解决问题后立即撷取除错洞察。通过监控如「it's fixed」或「/doc-fix」等对话触发词,该技能会自动提取技术背景(例如症状描述、根本原因、操作系统版本及特定代码调整),并将其组织成可搜索的 Markdown 知识库。这能确保每个已解决的问题都能成为未来开发周期的可重复利用范本,消除编译失败、GUI 宕机或 DSP 算法错误的遗忘曲线。

  • 自动撷取并清理问题症状、根本原因与技术解决方案,以便快速检索。

  • 强制执行严格的 YAML 前言架构,确保文件一致性与基于枚举的分类。

  • 执行基于 grep 的现有文件自动搜索,防止重复条目并建议相关参照。

  • 与模式侦测系统整合,识别重复发生的关键问题,从而推动架构的主动改进。

  • 支持编译失败、API 误用、阶段性实作错误及执行期诊断的系统化记录。

  • 问题验证后,可使用自然语言确认或 /doc-fix 指令触发文件记录流程。

  • 输入要求包括精确的错误日志、JUCE 版本、特定的插件阶段及可操作的修复步骤。

  • 系统会在存储至分类目录的 Markdown 文件前,针对预定义的枚举架构进行所有文件验证。

  • 若侦测到类似问题,系统会提示使用者进行双向参照,以加强组织知识网络。

  • 此工具仅限于已解决且经验证的问题;它会跳过如简单语法错误等琐碎修复,以维持高质量、专业的知识库。

仓库统计

Star 数
183
Fork 数
66
Open Issue 数
4
主要语言
HTML
默认分支
main
同步状态
空闲
最近同步时间
2026年4月29日 14:19
在 GitHub 查看