doc-consistency-reviewer
Обзор согласованности документации
Документация часто устаревает по мере развития кода. Этот навык систематически сравнивает документацию с исходным кодом, файлами конфигурации и контрактами API для выявления несоответствий до того, как они станут проблемой для пользователей.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「doc-consistency-reviewer」を使用しています。 Review documentation for consistency
期待される結果:
- ## Отчет о согласованности документации
- ### Проблемы P0 (Безопасность/Вводящие в заблуждение)
- 1. **Конфигурация contextIsolation**
- - В документации указано: 'contextIsolation включен для всех процессов рендерера'
- - В коде указано: `contextIsolation: false` в src/main/window.ts:23
- - Влияние: Пользователи считают, что у них есть изоляция безопасности, хотя её нет
- ### Проблемы P1 (Основной функционал)
- 2. **Формат ответа конечной точки API**
- - В документации указано: 'Возвращает имена полей в camelCase'
- - Код возвращает: имена полей в snake_case в src/api/users.ts:45
- - Влияние: Клиенты не смогут правильно разобрать данные ответа
「doc-consistency-reviewer」を使用しています。 Verify API docs match code
期待される結果:
- ## Аудит документации API
- **Согласованных элементов:** 15
- **Несоответствующих элементов:** 3
- | Элемент | Документация | Реализация | Серьезность |
- |------|---------------|----------------|----------|
- | Поля GET /users | id, name, email | id, user_name, email_address | P1 |
- | Обязательные поля POST /users | email | email, password | P1 |
- | Сообщение об ошибке 400 | 'Invalid input' | 'Validation failed' | P3 |
セキュリティ監査
安全All static findings are false positives. The 64 external_commands detections are markdown code blocks with shell examples in documentation, not executable code. The 17 weak_crypto detections are base64-encoded content in JSON/YAML files. The 9 obfuscation detections are high-entropy structured data patterns, not obfuscated payloads. Network detection is legitimate metadata (GitHub source URL). No actual security risks found.
品質スコア
作れるもの
Проверка документации перед выпуском
Перед выпуском релиза запустите этот навык для проверки всей документации на согласованность с кодом. Обнаруживайте устаревшие ссылки API, упоминания устаревших функций и ошибки конфигурации до того, как с ними столкнутся пользователи.
Проверка документации при адаптации
При присоединении к новому проекту используйте этот навык для быстрого выявления устаревшей документации. Получите полный список расхождений, которые могут запутать новых разработчиков или ввести их в заблуждение.
Аудит документации по безопасности
Сосредоточьтесь на документации по безопасности. Убедитесь, что конфигурации безопасности, методы аутентификации и модели разрешений, описанные в документах, действительно соответствуют реализации в коде.
これらのプロンプトを試す
Используйте навык doc-consistency-reviewer для проверки README и папки docs в этом проекте. Сравните каждое задокументированное утверждение с фактическим исходным кодом и файлами конфигурации. Перечислите все найденные несоответствия с доказательствами из документов и кода.
Сосредоточьтесь на документации API. Проверьте, что все конечные точки API, форматы запросов/ответов и коды ошибок, указанные в документации, соответствуют фактической реализации в исходном коде и любых файлах схем OpenAPI/proto/GraphQL.
Используйте навык doc-consistency-reviewer с фокусом на безопасность. Проверьте, что все конфигурации безопасности, потоки аутентификации, модели разрешений и настройки шифрования, указанные в документации, действительно реализованы в коде. Пометьте любые несоответствия, связанные с безопасностью, как проблемы P0/P1.
Проверьте всю документацию по конфигурации, включая переменные окружения, файлы конфигурации и флаги функций. Убедитесь, что задокументированные значения по умолчанию, обязательные настройки и доступные опции соответствуют тому, что код фактически ожидает и использует.
ベストプラクティス
- Проводите проверку документации перед каждым релизом для выявления регрессий
- Сосредоточьтесь на проверках безопасности на документации аутентификации, авторизации и защиты данных
- Используйте уровни серьезности (P0-P3) для определения приоритета исправления несоответствий
- Обновляйте документацию и код вместе для поддержания согласованности
回避
- Документирование функций, которых нет в кодовой базе
- Оставление примеров кода в документации, которые больше не работают
- Документирование значений конфигурации по умолчанию, отличающихся от фактических значений в коде
- Обновление документации без проверки по фактической реализации
よくある質問
Какие файлы проверяет этот навык?
Как он определяет, что правильно?
Он изменяет документацию?
Какие уровни серьезности используются?
Можно ли сосредоточиться на конкретных областях?
Какие типы несоответствий он обнаруживает?
開発者の詳細
作成者
hylarucoderライセンス
MIT
リポジトリ
https://github.com/hylarucoder/skills-for-vibe-coder/tree/main/skills/doc-consistency-reviewer参照
main
ファイル構成