doc-sync
Синхронизация документации IdeaVim с кодом
Документация IdeaVim может расходиться с Kotlin API и последними коммитами. Этот навык помогает Claude, Codex или Claude Code выполнять целевую проверку и обновление документации.
Установить с помощью моего Агента
Скопируйте этот запрос в своего Агента. Он содержит каноническую страницу Skill и манифест.
Review the Skillstore skill "doc-sync" from https://skillstore.io/skills/jetbrains-doc-sync.md and its manifest at https://skillstore.io/api/skills/jetbrains-doc-sync/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.Ваш Агент по-прежнему должен показать план и запросить все подтверждения, требуемые политикой безопасности.
Ресурсы для AI-агентов
Используйте эти ссылки, когда AI-агенту, crawler или script нужен чистый контекст вместо полной страницы.
Протестировать
Использование «doc-sync». Проверь doc/ideavim-mappings.md по текущим mapping API.
Ожидаемый результат:
Отчет перечисляет файл документации, проверенные файлы Kotlin API, каждое найденное несоответствие и точные обновления документации.
Использование «doc-sync». Я изменил MappingScope.kt. Нужно ли обновить документацию?
Ожидаемый результат:
Ответ определяет связанную документацию, объясняет, остаются ли примеры концептуально компилируемыми, и фиксирует любые правки или заметки для проверки сопровождающим.
Использование «doc-sync». Проведи аудит папки doc перед релизом.
Ожидаемый результат:
Вывод группирует проверенные файлы, подтвержденные расхождения, выполненные исправления документации и элементы с меньшей уверенностью, которым нужно подтверждение человеком.
Аудит безопасности
БезопасноAll 18 backtick findings are false positives caused by Markdown formatting or documented, read-only search and Git commands. The network-scanning finding is also false because nmap appears only as text inside a grep pattern.
Факторы риска
⚙️ Внешние команды (18)
Поделиться и цитировать этот отчет
Делитесь версионным отчетом об оценке, нейтральным значком, встраиваемой карточкой и цитатами. Skillstore публикует доказательства, не решая, безопасен ли этот Skill.
Копировать ссылку на отчёт
https://skillstore.io/skills/jetbrains-doc-sync/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportЗначок Markdown
[](https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge)Значок HTML
<a href="https://skillstore.io/skills/jetbrains-doc-sync?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/jetbrains-doc-sync/security.svg" alt="Skillstore security assessment" loading="lazy"></a>Встраиваемая карточка
<iframe src="https://skillstore.io/embed/skills/jetbrains-doc-sync.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>Академические ссылки (APA · BibTeX · CFF)
Цитата APA
JetBrains. (2026). doc-sync security audit report (audit version 9) [Author version unspecified]. Skillstore. https://skillstore.io/skills/jetbrains-doc-sync/audits/9Цитата BibTeX
@techreport{jetbrains-jetbrains-doc-sync-2026,
author = {JetBrains},
title = {doc-sync security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/jetbrains-doc-sync/audits/9},
note = {Author version unspecified}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "doc-sync security audit report (audit version 9)"
version: "unspecified"
type: report
authors:
- name: "JetBrains"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/jetbrains-doc-sync/audits/9"
identifiers:
- type: other
value: "skillstore:jetbrains-doc-sync:audit:9"
description: "Skillstore immutable audit report identifier"
Оценка Skillstore
Почему такая оценка Достоверность доказательств: ВысокийЧто вы можете построить
Проверка документации после изменений API
Проверить, требуют ли измененные Kotlin API обновлений в документации или примерах README.
Аудит существующих примеров кода
Сравнить задокументированные примеры с рабочими реализациями перед публикацией релиза.
Оценка влияния вклада
Выявить документацию, затронутую pull request, до его слияния.
Попробуйте эти промпты
Проверь, соответствует ли doc/ideavim-mappings.md текущему коду IdeaVim. Сообщи о любых неточных примерах и обнови только подтвержденные проблемы.
Я изменил MappingScope.kt. Проверь недавний diff, найди связанную документацию и обнови примеры, которые больше не соответствуют текущему API.
Проверь недавние коммиты с удалением или deprecation и выяви документацию, которая все еще ссылается на удаленные функции, параметры или файлы.
Проверь всю документацию в doc/ на наличие примеров API, которые отличаются от текущих рабочих реализаций. Приоритизируй критические неточности и суммируй нерешенные вопросы.
Лучшие практики
- Начинайте с рабочих примеров кода, прежде чем решать, что документация корректна.
- Проверяйте каждое задокументированное имя функции, имя параметра и шаблон использования по текущему API.
- Вносите небольшие правки в документацию, которые напрямую устраняют подтвержденное расхождение между кодом и документацией.
Избегать
- Не обновляйте документацию только на основе предпочтительных формулировок или изменений стиля.
- Не доверяйте примерам документации без проверки реальных реализаций.
- Не удаляйте полезный контекст, если текущий код не доказывает, что он неверен.