doc-sync
IdeaVim 문서와 코드 변경 사항 일치 여부 확인
문서经常在代码更新后发生漂移，导致用户的示例失效。这个技能提供了一个结构化的工作流程，用于将文档与有效的代码进行比较并识别差异。
스킬 ZIP 다운로드
Claude에서 업로드
설정 → 기능 → 스킬 → 스킬 업로드로 이동
토글을 켜고 사용 시작
테스트해 보기
"doc-sync" 사용 중입니다. README.md에서 오래된 매핑 예시 확인
예상 결과:
- 제거된 매개변수가 있는 두 개의 예시를 매핑 섹션에서 발견함
- README.md에서 이전 이름 대신 새로운 MappingScope 이름을 참조해야 함
- README 파일에서 다른 문제는 감지되지 않음
"doc-sync" 사용 중입니다. 2.0 �리스 후 doc/ideavim-api.md 검증
예상 결과:
- 릴리스 2.0에서 변경된 5개의 API 시그니처 식별함
- 예시의 3개 매개변수 이름을 새로운 시그니처와 일치하도록 업데이트해야 함
- 1개의 코드 블록에서 제거된 폐기된 메서드 사용
"doc-sync" 사용 중입니다. CONTRIBUTING.md가 현재 git 워크플로와 일치하는지 확인
예상 결과:
- CONTRIBUTING.md의 모든 git 명령어가 현재 브랜치 워크플로와 일치함
- 문서화된 단계와 실제 git 동작 간에 차이점 없음
보안 감사
안전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)
품질 점수
만들 수 있는 것
릴리스 후 감사
릴리스 주기가 완료된 후 문서가 최신 API 변경 사항을 반영하는지 확인합니다.
PR 전 문서 검토
문서 업데이트 변경 사항을 제출하기 전에 예시 및 매개변수 이름의 유효성을 검사합니다.
회귀 트라이지
보고된 문서 문제가 실제 코드 변경에 해당하는지 확인합니다.
이 프롬프트를 사용해 보세요
doc/ideavim-mappings.md를 현재 코드와 비교하고 발견된 불일치를 나열합니다.
MappingScope.kt를 변경했습니다. 영향받는 문서를 식별하고 구체적인 업데이트를 제안합니다.
doc/의 모든 파일에 대해 오래된 예시를 감사하고 보고서에서 발견 사항을 요약합니다.
현재 코드에서 map(), nmap(), vmap()을 사용하는 모든 예시를 현재 API 시그니처와 비교하여 검증합니다.
모범 사례
- 문서를 비교하기 전에 먼저 실제 구현에서ground truth를 확립합니다
- 문서 드리프트 확인 시 제거되거나 이름이 바뀐 API 요소를 우선시합니다
- 업데이트를 최소화하고 기존 문서 스타일 및 용어와 일치시킵니다
피하기
- 기본 동작이 여전히 정확할 때 wording만 업데이트합니다
- 코드 예시에서 명명된 매개변수 검증을 건너뜁니다
- 작동하는 구현을 확인하지 않고 문서가 정확하다고 가정합니다