doc-sync
Проверка соответствия документации IdeaVim изменениям в коде
Документация часто расходится с кодом после обновлений, что приводит к неработающим примерам для пользователей. Этот навык предоставляет структурированный рабочий процесс для сравнения документации с рабочим кодом и выявления расхождений.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «doc-sync». Проверить README.md на предмет устаревших примеров маппингов
Ожидаемый результат:
- Обнаружено два примера с удаленными параметрами в секции маппингов
- В README.md должно использоваться новое имя MappingScope вместо старого
- Других проблем в файле README не обнаружено
Использование «doc-sync». Проверить doc/ideavim-api.md после релиза 2.0
Ожидаемый результат:
- Обнаружено 5 сигнатур API, изменившихся в релизе 2.0
- 3 имени параметров в примерах требуют обновления для соответствия новым сигнатурам
- 1 блок кода использует устаревший метод, который был удален
Использование «doc-sync». Проверить соответствует ли CONTRIBUTING.md текущему git-workflow
Ожидаемый результат:
- Все git-команды в CONTRIBUTING.md соответствуют текущему workflow с ветками
- Расхождений между задокументированными шагами и реальным поведением 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)
⚙️ Внешние команды (18)
Оценка качества
Что вы можете построить
Аудит после релиза
Подтвердить, что документация отражает недавние изменения API после завершения цикла релиза.
Проверка документации перед PR
Проверить примеры и имена параметров перед отправкой изменений в обновлении документации.
Триаж регрессий
Проверить, соответствуют ли сообщаемые проблемы с документацией реальным изменениям API в коде.
Попробуйте эти промпты
Проверьте doc/ideavim-mappings.md на соответствие текущему коду и перечислите найденные несоответствия.
Я изменил MappingScope.kt. Определите затронутую документацию и предложите конкретные обновления.
Проведите аудит всех файлов в doc/ на предмет устаревших примеров и суммируйте результаты в отчете.
Проверьте все примеры с использованием map(), nmap() и vmap() на соответствие текущим сигнатурам API в коде.
Лучшие практики
- Начните с рабочей реализации, чтобы установить основу истины перед сравнением с документацией
- Приоритизируйте удаленные или переименованные элементы API при проверке расхождений документации
- Сохраняйте минимальность обновлений и соответствие существующему стилю и терминологии документации
Избегать
- Обновление формулировок, когда базовое поведение все еще корректно
- Пропуск проверки именованных параметров в примерах кода
- Предположение о корректности документации без проверки рабочей реализации