> ## 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
> От чистой установки до первой оценки с помощью LLM за несколько минут. Подключите модель, добавьте проект, укажите критерии оценки, загрузите документ и просмотрите результаты.
Это руководство проведёт вас через полный цикл первой оценки в Doc Reviewer — от подключения LLM до просмотра результатов и их экспорта. По завершении у вас будет рабочий процесс оценки, который вы сможете повторять для любого документа.
**Через .exe:** дважды щёлкните `doc-reviewer.exe`. Приложение стартует локальный бэкенд и автоматически открывает интерфейс в браузере. Если браузер не открылся, перейдите на `http://localhost:8000`.
**Из исходного кода:** выполните команду из корня проекта:
```bash theme={null}
python run_dev.py
```
Затем откройте `http://localhost:5173` в браузере.
При первом запуске создаётся файл базы данных `data\db.sqlite` рядом с `.exe` и заполняется начальными моделями LLM и критериями оценки. Это занимает несколько секунд.
Doc Reviewer использует LLM для оценки инструкций. Перейдите в **Настройки → Модели**.
Вы увидите список преднастроенных моделей. Чтобы активировать одну из них:
1. Нажмите на нужную модель (например, `gpt-4o` или `claude-3-5-sonnet`).
2. Введите API-ключ в поле **API-ключ**.
3. Нажмите **Сохранить**.
4. Нажмите **Сделать активной** — это выбранная модель будет использоваться для оценки.
```text OpenAI theme={null}
Base URL: https://api.openai.com/v1
API-ключ: sk-...
```
```text Anthropic theme={null}
Base URL: https://api.anthropic.com/v1
API-ключ: sk-ant-...
```
```text Ollama (локально, ключ не нужен) theme={null}
Base URL: http://localhost:11434/v1
API-ключ: (оставьте пустым)
```
Если вы используете Ollama, убедитесь, что сервер Ollama запущен локально до начала оценки. API-ключ не нужен.
Проекты группируют документы одного продукта, чтобы Doc Reviewer использовал общий контекст для повышения точности оценки.
1. Нажмите **Проекты** в левом меню.
2. Нажмите **Новый проект**.
3. Введите название, идентифицирующее продукт (например, `Firewall Manager` или `API Gateway`).
4. Нажмите **Создать**.
Вы перейдёте на страницу проекта. Контекст продукта можно добавить позже — он помогает LLM учитывать терминологию, аудиторию и компоненты продукта при оценке инструкций.
Загрузите файл на странице проекта:
1. Нажмите **Добавить документ** или перетащите файл в область загрузки.
2. Doc Reviewer принимает файлы PDF, DOCX, Markdown (`.md`) и обычный текст (`.txt`).
3. Дождитесь завершения загрузки и разбора. Структура документа появится в дереве слева.
Чтобы загрузить веб-страницу:
1. Перейдите в **Оценить → По URL**.
2. Вставьте URL страницы и нажмите **Загрузить**.
3. Страница загрузится через headless-браузер Chromium, поэтому страницы с JavaScript отображаются корректно.
Для загрузки веб-страниц нужен установленный Chromium. Подробнее — в разделе [Установка Doc Reviewer](/ru/installation).
После разбора Doc Reviewer автоматически классифицирует каждый раздел документа. Разделы, определённые как инструкции или возможные инструкции, выделяются в дереве документа.
Просмотрите дерево, чтобы убедиться, что обнаруженные разделы определены верно. Если раздел ошибочно помечен как инструкция или пропущен, вы можете изменить его классификацию вручную, щёлкнув на раздел и выбрав другой тип. Разделы с типом **не инструкция** исключаются из оценки LLM.
Нажмите **Оценить** в верхней панели просмотра документа.
Doc Reviewer отправляет каждый раздел с инструкциями в активную LLM вместе с критериями оценки и получает результаты в режиме реального времени. Индикатор прогресса показывает, сколько разделов уже оценено. В зависимости от количества инструкций и скорости LLM оценка документа среднего размера занимает 20–90 секунд.
Если для проекта задан контекст продукта, он автоматически включается в каждый запрос на оценку — дополнительных действий не нужно.
После завершения оценки каждая инструкция в дереве документа показывает цветовой индикатор:
| Цвет | Значение |
| --------- | ----------------------------------------------------- |
| Зелёный | Инструкция соответствует всем критериям |
| Жёлтый | Незначительные недочёты — легко исправить |
| Оранжевый | Проблемы, влияющие на удобство использования |
| Красный | Критические недочёты, требующие немедленного внимания |
Нажмите на любую инструкцию, чтобы увидеть подробный разбор: какие критерии выполнены, какие нарушены, и конкретные рекомендации LLM по улучшению.
Если результат кажется ошибочным — например, LLM отметила проблему, неприменимую к вашему продукту — нажмите **Отметить как ложное срабатывание**, чтобы исключить этот результат из итоговой оценки. Ложные срабатывания сохраняются при повторных оценках.
Нажмите **Как работает оценка? ↗** в сводной панели над результатами, чтобы подробнее разобраться в системе баллов.
Чтобы поделиться результатами или зафиксировать их, нажмите **Экспорт** в верхней панели.
Doc Reviewer скачает файл `.xlsx` с одной строкой на инструкцию, включая заголовок раздела, цветовую оценку, результаты по критериям и рекомендации.
Чтобы сохранить снимок результатов в конкретный момент времени — полезно для сравнения качества между версиями документа — нажмите **Сохранить снимок** и задайте имя. Сравнение снимков доступно на странице **Снимки**.
## Следующие шаги
После первой оценки изучите дополнительные возможности:
Сгенерируйте контекст продукта для проекта, чтобы повысить точность оценки специализированной терминологии.
Отредактируйте критерии оценки по умолчанию или создайте новый набор под стандарты вашей документации.
Загружайте страницы документации по URL с помощью встроенного headless-браузера.
Сохраняйте результаты оценки в виде снимков и отслеживайте улучшения качества между версиями.