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 — настольное приложение, которое сканирует вашу техническую документацию — PDF, Word‑документы, файлы Markdown и веб‑страницы, находит в них инструкции и оценивает их по настраиваемому набору критериев с помощью LLM. Каждая инструкция получает цветовую оценку (зелёный, жёлтый, оранжевый или красный) и рекомендации для улучшения. Всё работает локально на вашем компьютере — без облачного аккаунта, без передачи данных, без подписки.

Установить Doc Reviewer

Скачайте .exe, установите Chromium для работы с веб‑страницами и запустите приложение за несколько минут.

Быстрый старт

Подключите LLM, загрузите первый документ и выполните первую оценку пошагово.

Проекты

Группируйте документы по продукту, генерируйте контекст продукта и повышайте точность оценки.

Оценка

Разберитесь, как Doc Reviewer выставляет оценки инструкциям и что означает каждый цвет.

Модели LLM

Подключите OpenAI, Anthropic, Ollama или любой совместимый с OpenAI API.

Что делает Doc Reviewer

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

Для кого предназначен Doc Reviewer

Doc Reviewer создан для технических писателей в компаниях, которые разрабатывают продукты в области кибербезопасности, инструменты для разработчиков и сложное корпоративное ПО — продукты с большими наборами документации, где ручная проверка каждой инструкции непрактична. Если вы ведёте руководства по процедурам, пользовательские руководства или справку в формате веб‑страниц и хотите последовательно проверять качество инструкций перед выпуском, Doc Reviewer построен для этого рабочего процесса.

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

1

Установка и запуск

Скачайте doc-reviewer.exe и запустите его. Приложение стартует локальный сервер на localhost:8000 и автоматически открывает интерфейс в браузере.
2

Подключение LLM

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

Создание проекта и загрузка документов

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

Запуск оценки и просмотр результатов

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

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

Поддержка множества форматов

Doc Reviewer анализирует PDF, DOCX, Markdown и TXT файлы. Он загружает веб‑страницы по URL с помощью Playwright и headless‑браузера Chromium, включая страницы с JavaScript и SPA.

Автоматическое обнаружение инструкций

Doc Reviewer находит разделы с инструкциями автоматически с помощью морфологического анализа. Ручная разметка и предварительная обработка не нужны.

Настраиваемые критерии оценки

Используйте встроенный набор критериев или создайте свой. Редактируйте и управляйте критериями прямо в Настройках → Критерии в формате Markdown.

Контекст продукта для повышения точности

Сгенерируйте описание продукта для каждого проекта. LLM использует его, чтобы понять терминологию и аудиторию продукта при оценке инструкций.

Извлечение глоссария (YAKE)

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

Умная переоценка при замене документа

При замене документа Doc Reviewer сопоставляет разделы с предыдущей версией. Неизменённые разделы используют прежние оценки, частично изменённые получают подсказки diff, а новые части оцениваются заново.

Снимки и сравнение версий

Сохраняйте результаты оценки в виде именованных снимков и сравнивайте качество между версиями документа, чтобы отслеживать улучшения.

Локальная работа и конфиденциальность

Все данные хранятся в локальной базе данных SQLite рядом с .exe. Ничто не покидает ваш компьютер, кроме вызовов LLM API к выбранному провайдеру.