doc-sync
IdeaVim-Dokumentation mit Codeänderungen abgleichen
Dokumentation driftet nach Code-Updates häufig auseinander und erzeugt fehlerhafte Beispiele für Nutzer. Diese Fähigkeit bietet einen strukturierten Workflow, um Doku gegen funktionierenden Code zu vergleichen und Abweichungen zu identifizieren.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "doc-sync". Check README.md for outdated mappings examples
Erwartetes Ergebnis:
- Zwei Beispiele mit entfernten Parametern im Mappings-Abschnitt gefunden
- README.md sollte den neuen MappingScope-Namen statt des alten Namens referenzieren
- Keine weiteren Probleme in der README-Datei festgestellt
Verwendung von "doc-sync". Verify doc/ideavim-api.md after the 2.0 release
Erwartetes Ergebnis:
- 5 API-Signaturen identifiziert, die sich in Release 2.0 geändert haben
- 3 Parameternamen in Beispielen müssen aktualisiert werden, um den neuen Signaturen zu entsprechen
- 1 Codeblock verwendet eine veraltete Methode, die entfernt wurde
Verwendung von "doc-sync". Check if CONTRIBUTING.md matches current git workflow
Erwartetes Ergebnis:
- Alle Git-Befehle in CONTRIBUTING.md entsprechen dem aktuellen Branch-Workflow
- Keine Abweichungen zwischen dokumentierten Schritten und tatsächlichem Git-Verhalten gefunden
Sicherheitsaudit
SicherAll 35 static findings are FALSE POSITIVES. The static analyzer misidentified markdown documentation text as security threats. SKILL.md is pure documentation containing workflow instructions and example bash commands shown as documentation - no executable code exists. The skill-report.json already correctly assessed this as safe with no risk factors.
Risikofaktoren
🌐 Netzwerkzugriff (1)
📁 Dateisystemzugriff (1)
⚙️ Externe Befehle (18)
Qualitätsbewertung
Was du bauen kannst
Audit nach Release
Bestätigen, dass die Dokumentation aktuelle API-Änderungen nach Abschluss eines Release-Zyklus widerspiegelt.
Doc-Review vor PR
Beispiele und Parameternamen vor dem Einreichen von Dokumentationsänderungen validieren.
Regressions-Triage
Prüfen, ob gemeldete Dokumentationsprobleme realen API-Änderungen im Code entsprechen.
Probiere diese Prompts
Check doc/ideavim-mappings.md against current code and list any mismatches found.
I changed MappingScope.kt. Identify affected documentation and propose specific updates.
Audit all files in doc/ for outdated examples and summarize findings in a report.
Validate all examples using map(), nmap(), and vmap() against current API signatures in code.
Bewährte Verfahren
- Mit einer funktionierenden Implementierung beginnen, um die Ground Truth festzulegen, bevor die Doku verglichen wird
- Entfernte oder umbenannte API-Elemente bei der Prüfung auf Dokumentationsdrift priorisieren
- Updates minimal halten und an bestehenden Dokumentationsstil sowie Terminologie ausrichten
Vermeiden
- Wording aktualisieren, obwohl das zugrunde liegende Verhalten weiterhin korrekt ist
- Die Verifikation benannter Parameter in Codebeispielen überspringen
- Annehmen, dass die Dokumentation korrekt ist, ohne die funktionierende Implementierung zu prüfen