Peter View
Результат проверки: документ с подсветкой фрагментов и список замечаний

Автоматическая вычитка русской документации

Peter View проверяет русские тексты по грамматике, корпоративному стилю и единообразию терминов. Результат: список замечаний, каждое привязано к фрагменту документа. Система разворачивается в вашей инфраструктуре. Исходные тексты во внешние сервисы не передаются, пока вы сами не укажете адрес языковой модели.

git clone https://github.com/BadWisher/Peter-View.git
cd Peter-View
./deploy.sh

После запуска откройте http://localhost:3080. Учётная запись по умолчанию: admin / admin. Первый запуск занимает около полутора минут: инициализируется проверка языка.

Открыть превью

Превью показывает интерфейс без сервера. Чтобы проверять свои тексты, установите систему: установка и первый запуск.

Как устроена проверка

Сначала задаётся документ и состав проверки. Затем просматривается список замечаний. Корпоративный стиль хранится отдельно, в том же интерфейсе.

Раздел Вычитка: выбор источника и параметров проверки
1. Источник и состав проверки. Раздел «Вычитка». Вкладки «Текст», «Файл» (docx, txt, html, md) и «Ссылка». Справа независимые параметры: «Язык и ясность», «Style Guide», «Термины и согласованность». Запуск: «Начать вычитку».
Список замечаний рядом с текстом документа
2. Список замечаний. Экран «Очередь решений»: слева документ, справа карточки «Ошибка», «Замечание», «Совет». Клавиши J и K переключают карточки, H скрывает текущую. «Экспорт» сохраняет видимые замечания в xlsx.

J далее

K назад

H скрыть

Раздел Style Guide
3. Корпоративный стиль. Раздел «Style Guide». «Использовать» назначает гайд для следующей проверки. Администратор импортирует правила из docx.

Style Guide

В поставку входит встроенный набор правил. Собственный гайд загружается из docx: правила и словарь. Редактор выбирает гайд для проверки. Изменять правила может только администратор.

Назначение и импорт гайда

Инфраструктура

РазвёртываниеDocker Compose. Три контейнера: интерфейс, сервер приложений, проверка языка
ПамятьПроверка языка около 1.5 ГБ, сервер приложений до 2 ГБ
ДанныеТом backend-data. Резервная копия: make backup
Языковая модельНе требуется для грамматики и гайда. Для проверки по смыслу указывается свой API в «Настройках»
АутентификацияЛокальный пароль или OIDC (Keycloak, Azure AD)
ЛицензияApache-2.0
Экран входа

Учётная запись по умолчанию: admin / admin. Пока пароль не изменён, любой, кто имеет доступ к порту, получает права администратора. Смена пароля: меню учётной записи → «Сменить пароль».

Администрирование

Пользователи, адрес модели и состояние сервисов доступны администратору сразу после установки. Языковая модель не обязательна: грамматика и Style Guide работают без неё.

Список пользователей
Пользователи. Логин, роль «Редактор» или «Администратор». Пароль не короче 8 символов. Общий вход admin для рабочей группы не подходит.
Настройки языковой модели
Настройки. Адрес API с протоколом OpenAI, имя модели, ключ. «Проверить подключение» сообщает, отвечает ли сервер.
Состояние сервисов
Система. Диск, модель, эмбеддинги, репозиторий, резервная копия. Пустой адрес модели даёт статус «Недоступно»: это ожидаемо, а не поломка грамматики.

История и аналитика

История проверок
История. Завершённые проверки: источник, дата, число находок, имя гайда. Стрелка открывает тот же отчёт.
Аналитика частых правил
Аналитика. Какие правила срабатывают чаще и у кого. Счётчики токенов заполняются, если использовалась модель.

Дополнительные разделы

По умолчанию выключены. Включаются флагами в .env без пересборки интерфейса: FEATURE_DOCUMENTS, FEATURE_API, FEATURE_WATCH, FEATURE_SCREENSHOTS.

Репозиторий документов
Документы. Папки, версии файлов, архив, поиск по ключу Jira.
Связка OpenAPI
API. Связка русской и английской спецификаций: поля, единообразие, изменения.
Наблюдение за страницами
Наблюдение. Снимки страниц. Статусы: не проверялась, без изменений, изменилась, ошибка.
Редактор скриншотов
Скриншоты. Кадрирование, скрытие областей, шаблон ширины, выгрузка PNG.

Документация