> ## Documentation Index
> Fetch the complete documentation index at: https://www.doc-reviewer.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Doc Reviewer: оценка качества инструкций с помощью ИИ

> Doc Reviewer — настольное приложение для технических писателей, которое использует LLMs для автоматического обнаружения и оценки качества инструкций в вашей документации.

Doc Reviewer — настольное приложение, которое сканирует вашу техническую документацию — PDF, Word‑документы, файлы Markdown и веб‑страницы, находит в них инструкции и оценивает их по настраиваемому набору критериев с помощью LLM. Каждая инструкция получает оценку с наглядной цветовой индикацией и рекомендации для улучшения. Всё работает локально на вашем компьютере — без облачного аккаунта, без передачи данных, без подписки.

<CardGroup cols={2}>
  <Card title="Установить Doc Reviewer" icon="download" href="/ru/installation">
    Скачайте `.exe`, установите Chromium для работы с веб‑страницами и запустите приложение за несколько минут.
  </Card>

  <Card title="Быстрый старт" icon="bolt" href="/ru/quickstart">
    Подключите LLM, загрузите первый документ и выполните первую оценку пошагово.
  </Card>

  <Card title="Проекты" icon="folder" href="/ru/concepts/projects">
    Группируйте документы по продукту, генерируйте контекст продукта и повышайте точность оценки.
  </Card>

  <Card title="Оценка" icon="chart-bar" href="/ru/concepts/evaluation">
    Разберитесь, как Doc Reviewer выставляет оценки инструкциям и что означает каждый цвет.
  </Card>

  <Card title="Модели LLM" icon="sliders" href="/ru/configuration/llm-models">
    Подключите OpenAI, Anthropic, Ollama, любой совместимый с OpenAI API, или добавьте собственную модель.
  </Card>
</CardGroup>

## Что делает Doc Reviewer

Когда вы загружаете документ, Doc Reviewer разбирает его на разделы и классифицирует каждый с помощью морфологического анализа. Разделы, содержащие инструкции — процедурные шаги, описания задач, последовательности действий — отправляются в LLM для оценки. LLM проверяет каждую инструкцию по критериям: стиль заголовка, структура шагов, полнота и описание результата, затем возвращает оценку и рекомендации.

Результаты отображаются цветом для быстрого анализа:

* **Зелёный** — инструкция соответствует всем критериям
* **Жёлтый** — незначительные недочёты, которые легко исправить
* **Оранжевый** — проблемы, влияющие на удобство использования
* **Красный** — критические недочёты, требующие немедленного внимания

Вы можете просматривать результаты в дереве документа, отмечать ложные срабатывания, экспортировать в XLS или другие форматы и сохранять снимки оценки для сравнения качества между версиями документа.

## Как работает Doc Reviewer

<Steps>
  <Step title="Установка и запуск">
    Скачайте `doc-reviewer.exe` и запустите его. Приложение стартует локальный сервер на `localhost:8000` и автоматически открывает интерфейс в браузере.
  </Step>

  <Step title="Подключение LLM">
    Перейдите в **Настройки → Модели** и добавьте провайдера LLM: OpenAI, Anthropic, Ollama или любой совместимый с OpenAI API. API‑ключ хранится локально в базе данных.
  </Step>

  <Step title="Создание проекта и загрузка документов">
    Создайте проект для продукта, затем загрузите файлы PDF, DOCX, Markdown или TXT — или вставьте URL, чтобы загрузить веб‑страницу через встроенный headless‑браузер.
  </Step>

  <Step title="Запуск оценки и просмотр результатов">
    Нажмите **Оценить**, чтобы проанализировать все обнаруженные разделы с инструкциями. Просмотрите цветовые оценки с рекомендациями, отметьте ложные срабатывания и экспортируйте результаты в XLS или другие форматы.
  </Step>
</Steps>

## Ключевые возможности

<CardGroup cols={2}>
  <Card title="Поддержка множества форматов" icon="file-lines">
    Doc Reviewer анализирует PDF, DOCX, Markdown и TXT файлы. Он загружает веб‑страницы по URL с помощью Playwright и headless‑браузера Chromium, включая страницы с JavaScript и SPA.
  </Card>

  <Card title="Автоматическое обнаружение инструкций" icon="magnifying-glass">
    Doc Reviewer находит разделы с инструкциями автоматически с помощью морфологического анализа. Ручная разметка и предварительная обработка не нужны.
  </Card>

  <Card title="Настраиваемые критерии оценки" icon="list-check">
    Используйте встроенный набор критериев или создайте свой. Редактируйте и управляйте критериями прямо в **Настройках → Критерии** в формате Markdown.
  </Card>

  <Card title="Контекст продукта для повышения точности" icon="brain">
    Сгенерируйте описание продукта для каждого проекта. LLM использует его, чтобы понять терминологию и аудиторию продукта при оценке инструкций.
  </Card>

  <Card title="Извлечение глоссария (YAKE)" icon="book">
    Doc Reviewer автоматически извлекает глоссарий терминов продукта из каждого документа. Глоссарий добавляется в подсказки LLM, что уменьшает количество ложных срабатываний и повышает релевантность.
  </Card>

  <Card title="Умная переоценка при замене документа" icon="refresh">
    При замене документа Doc Reviewer сопоставляет разделы с предыдущей версией. Неизменённые разделы используют прежние оценки, частично изменённые получают подсказки diff, а новые части оцениваются заново.
  </Card>

  <Card title="Снимки и сравнение версий" icon="code-compare">
    Сохраняйте результаты оценки в виде именованных снимков и сравнивайте качество между версиями документа, чтобы отслеживать улучшения.
  </Card>

  <Card title="Локальная работа и конфиденциальность" icon="lock">
    Все данные хранятся в локальной базе данных SQLite рядом с `.exe`. Ничто не покидает ваш компьютер, кроме вызовов LLM API к выбранному провайдеру.
  </Card>
</CardGroup>