Was macht compound-docs?
Erfasen Sie gelöste Probleme als kategorisierte Dokumentation mit YAML-Frontmatter für schnelles Nachschlagen.
Beschreibung
Dieser Agenten-Skill ermöglicht es Ihnen, Probleme und Lösungen aus Ihrer Arbeit in einer durchsuchbaren Dokumentation zu speichern. Jeder Eintrag wird als Markdown-Datei mit YAML-Frontmatter gespeichert, sodass Metadaten wie Tags, Kategorie, Datum und eine Zusammenfassung leicht extrahiert werden können.
Funktionsweise
- Der Agent erkennt ein gelöstes Problem im Gesprächsverlauf.
- Er extrahiert die wichtigsten Informationen: Problembeschreibung, Lösung, beteiligte Technologien, Kontext.
- Der Agent erstellt oder aktualisiert eine Markdown-Datei im Dokumentationsordner (standardmäßig
docs/solutions/). - Die Datei enthält YAML-Frontmatter mit strukturierten Metadaten.
- Der Agent kann später mithilfe dieser Metadaten schnell relevante Lösungen finden.
Konfiguration
- Standard-Dokumentationspfad:
docs/solutions/ - YAML-Frontmatter-Felder:
title: Kurzer Titel der Lösungdate: Datum der Erfassungcategory: Kategorie (z. B. debugging, deployment, testing)tags: Liste von Schlagwörternproblem: Kurze Problembeschreibungsolution: Kurze Lösungsbeschreibung
Beispiel
---
title: "Fehlerbehebung bei MySQL-Verbindungsabbrüchen"
date: 2025-03-15
category: debugging
tags:
- mysql
- connection
- timeout
problem: "MySQL-Verbindung bricht nach 30 Sekunden Inaktivität ab"
solution: "wait_timeout in der MySQL-Konfiguration auf 300 erhöhen"
---
## Problem
Bei längerer Inaktivität zwischen Anwendung und MySQL-Datenbank wird die Verbindung getrennt.
## Lösung
Setzen Sie `wait_timeout = 300` in der MySQL-Konfigurationsdatei und starten Sie den Dienst neu.
## Quellen
- [MySQL-Dokumentation zu wait_timeout](https://dev.mysql.com/doc/refman/8.0/en/server-system-variables.html#sysvar_wait_timeout)
Plattformen
- Claude Code
- Cursor
- Codex (mit Dateisystemzugriff)
Verwendung
Um diesen Skill zu nutzen, stellen Sie sicher, dass der Agent das Verzeichnis docs/solutions/ erstellen kann, falls es nicht existiert. Der Agent sollte bei jeder erfolgreichen Lösung eines wiederkehrenden Problems eine neue Dokumentationsdatei anlegen.
Lizenz
MIT