Назначение системы

Peter View - система автоматической вычитки русской документации. Она нужна команде, которая перед публикацией должна проверить грамматику, корпоративный стиль и термины и при этом не отправлять исходные тексты во внешний сервис вычитки.

Типичный читатель этой документации: технический писатель или редактор, которому поручили выбрать или внедрить автоматическую проверку русских руководств, API-описаний, регламентов.

Что система делает

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

Проверяются три независимых слоя:

1. Язык: грамматика, пунктуация, типовые формулировки.
2. Корпоративный стиль: правила выбранного Style Guide.
3. Термины: словарь гайда и единообразие наименований.

Языковую модель подключать не обязательно. Грамматика и гайд заполняют список замечаний и без неё. Модель нужна, когда требуется найти то, что не выражается правилом: сбивчивый абзац, термин не в том контексте.

Чего система не делает

Тексты в интерфейсе не редактируются. Список замечаний служит для решения, что перенести в исходный файл вручную. Скрытая карточка остаётся в отчёте: она только убрана с экрана на время просмотра.

Peter View не заменяет систему управления документами. Репозиторий файлов, наблюдение за сайтами и редактор иллюстраций включаются отдельно и не обязательны для вычитки.

Проверка не отправляется на адрес репозитория проекта. Данные хранятся в томе Docker. Адрес модели, если он задан, и вход через организацию принадлежат вашей инфраструктуре.

Как читать дальше

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