Skip to main content

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 — локальное настольное приложение, но оно использует веб-интерфейс. При запуске doc-reviewer.exe приложение стартует локальный бэкенд-сервер на localhost:8000 и автоматически открывает интерфейс в браузере по умолчанию. Интернет-соединение для работы самого приложения не нужно. Единственные исходящие сетевые вызовы Doc Reviewer — это запросы к LLM API к настроенному вами провайдеру: OpenAI, Anthropic или локальной модели через Ollama.
Ваши документы хранятся полностью на вашем компьютере. При запуске оценки Doc Reviewer отправляет текст каждого раздела с инструкцией в настроенный вами LLM API — и ничего больше. Файлы хранятся в локальной папке data/uploads/ рядом с .exe, а все метаданные, результаты оценки и настройки хранятся в локальной базе данных SQLite по адресу data/db.sqlite. API-ключи хранятся локально в этой базе данных и не передаются никуда, кроме API-endpoint вашего провайдера LLM.
Для наиболее точных результатов оценки используйте мощную модель: GPT-4o (OpenAI) или Claude 3.5 Sonnet (Anthropic). Если вы предпочитаете модели с открытым исходным кодом через Ollama, выбирайте модель с параметрами от 70 миллиардов — менее крупные модели, как правило, дают менее надёжные оценки по критериям и могут выдавать расплывчатые или непоследовательные рекомендации.
Если результаты оценки выглядят непоследовательно или явно неверно, первое, что нужно проверить, — это модель LLM. Переключитесь на более мощную модель в Настройках → Модели и повторите оценку.
Да. Doc Reviewer поддерживает любой совместимый с OpenAI API, включая локальные модели, запущенные через Ollama. Чтобы настроить локальную модель, перейдите в Настройки → Модели, добавьте новую модель и задайте base URL http://localhost:11434/v1. Поле API-ключа оставьте пустым — Ollama не требует аутентификации. Убедитесь, что Ollama запущена с нужной моделью до начала оценки.
Для работы с веб-страницами нужен Chromium, который не входит в комплект .exe. Если вы его ещё не установили, выполните в терминале:
py -3.11 -m playwright install chromium
Если Chromium установлен, но страница всё равно не загружается, сайт может блокировать headless-браузеры. Некоторые сайты определяют автоматизированные запросы и возвращают ошибку или пустую страницу. В этом случае скачайте страницу в формате PDF или DOCX и загрузите файл вместо URL.
Несколько факторов могут привести к неточным результатам:
  • Слабая LLM-модель — небольшие или плохо настроенные модели дают ненадёжные оценки. Переключитесь на более мощную модель в Настройках → Модели.
  • Отсутствует контекст продукта — без контекста LLM оценивает инструкции, не зная терминологии и аудитории продукта. Откройте страницу проекта, сгенерируйте или напишите контекст продукта, затем повторите оценку.
  • Неподходящие критерии — активный набор критериев может не соответствовать стилю вашей документации. Просмотрите или настройте критерии в Настройках → Критерии.
  • Ложные срабатывания — если конкретный критерий некорректно помечает ошибку в определённой инструкции, отметьте её как ложное срабатывание с помощью переключателя переопределения на панели результатов оценки.
Да, Doc Reviewer оценивает документы на английском языке. Встроенный набор критериев по умолчанию и описание роли LLM написаны на русском. Для лучших результатов с английскими документами перейдите в Настройки → Критерии, откройте активный набор и переведите текст критериев на английский. Также переведите раздел ## Роль в начале файла — он используется как роль в системном промпте LLM.Автоматическое обнаружение инструкций использует морфологический анализ, оптимизированный для русского языка. Точность обнаружения для заголовков на английском может быть ниже — вы можете вручную изменить классификацию пропущенных или неверно классифицированных разделов.
Все данные хранятся в папке data/ рядом с doc-reviewer.exe:
  • data/db.sqlite — база данных SQLite со всеми проектами, документами, результатами оценки, настройками моделей и наборами критериев
  • data/uploads/ — исходные файлы документов, которые вы загрузили
Не перемещайте и не удаляйте эти файлы во время работы приложения. Чтобы создать резервную копию данных, скопируйте всю папку data/.
Чтобы перейти на новую версию, замените doc-reviewer.exe новым файлом. Папка data/ — включая data/db.sqlite и все загруженные документы — хранится отдельно и переносится автоматически. Повторная настройка не нужна.
Если схема базы данных изменяется между версиями, Doc Reviewer выполняет автоматические миграции при запуске. В редких случаях, когда миграция не может быть применена, вам может потребоваться удалить db.sqlite и настроить приложение заново. В примечаниях к релизу это будет указано явно.
В Doc Reviewer нет встроенных средств командного обмена. Для передачи результатов используйте один из следующих способов:
  • Экспорт в XLS — нажмите Экспорт на странице оценки, чтобы скачать таблицу со всеми результатами и рекомендациями. Передайте файл по электронной почте или через общую папку.
  • Снимки — сохраните именованный снимок текущего состояния оценки. Снимки позволяют отслеживать качество со временем и сравнивать версии, но хранятся локально и не могут быть переданы напрямую.
Развёртывание в многопользовательском или серверном режиме не поддерживается.
Обнаружение инструкций использует морфологический анализ, обученный на русскоязычных текстах. Он ищет паттерны в заголовках разделов — глагольно-именные сочетания и другие конструкции, указывающие на процедурный шаг, характерные для русской грамматики.Документы на английском языке загружаются и оцениваются без ошибок, но точность автоматической классификации может быть ниже. Больше разделов может получить классификацию возможная инструкция или не инструкция вместо инструкция. Вы можете исправить это вручную, нажав на значок классификации раздела в дереве документа и выбрав нужное значение.
Контекст продукта — это краткое текстовое описание продукта (~400–700 слов): его название, аудитория, ключевая терминология и основные компоненты. При задании контекста продукта для проекта Doc Reviewer включает его в каждый запрос LLM на оценку документов в этом проекте. Это позволяет модели оценивать инструкции, опираясь на знания о предметной области продукта, а не угадывая только из текста инструкции.Контекст продукта заметно повышает точность оценки специализированных инструкций с отраслевой терминологией. Вы можете сгенерировать его автоматически из не-инструкционных разделов ваших документов, нажав Сгенерировать контекст на странице проекта, или написать вручную.