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.
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"doc-sync" 사용 중입니다. Check README.md for outdated mappings examples
예상 결과:
- 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
"doc-sync" 사용 중입니다. Verify doc/ideavim-api.md after the 2.0 release
예상 결과:
- 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
"doc-sync" 사용 중입니다. Check if CONTRIBUTING.md matches current git workflow
예상 결과:
- Alle Git-Befehle in CONTRIBUTING.md entsprechen dem aktuellen Branch-Workflow
- Keine Abweichungen zwischen dokumentierten Schritten und tatsächlichem Git-Verhalten gefunden
보안 감사
안전All 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.
위험 요인
🌐 네트워크 접근 (1)
📁 파일 시스템 액세스 (1)
품질 점수
만들 수 있는 것
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.
이 프롬프트를 사용해 보세요
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.
모범 사례
- 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
피하기
- 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