Peter View

Open source веб-сервис для автоматической вычитки технической документации.
От техписателя техписателям с любовью.

   

Peter View - это инструмент для автоматизированной проверки текстов, предназначенный для контроля грамматики, соблюдения корпоративного стиля, гайдлайнов, tone of voice и единообразия терминологии.
Система спроектирована с упором на конфиденциальность и корпоративную разработку: по умолчанию все проверки выполняются локально, интеграция с ИИ моделями опциональная и доступна с любыми OpenAI API.
Результатом работы инструмента является структурированный список замечаний, каждое из которых привязано к конкретному фрагменту исходного документа.

Возможности вычитки

• Peer Review файла (DOCX, TXT, HTML, MD до 50 МБ), страницы по URL или текста в свободном виде.
• Выбор набора гайдлайнов (Style Guide) для нужной целевой аудитории, который будет использоваться при вычитке.
• Импорт, обновление и удобный интерфейс настройки Style Guide.
• Удобный просмотр и обработка результатов вычитки.
• Экспорт в .xlsx.
• История проверок, аналитика частых ошибок и состояния ИИ моделей.
• Ролевая модель, ограничивающая доступ к части настроек определенным пользователям.

Дополнительные модули

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

• FEATURE_DOCUMENTS=true. Добавляет в интерфейс раздел Документы - небольшой репозиторий/хранилище для документации.
• FEATURE_API=true. Добавляет в интерфейс раздел API - удобный интерфейс для вычитки документации OpenAPI, оформленной в виде интерфейса Smartcat. Также поддерживает автоматические вычитку и перевод.
• FEATURE_WATCH=true. Добавляет в интерфейс раздел Наблюдение - используется для мониторинга изменений на указанных страницах. Use Case: разработчики изменили интерфейс сервиса, но не уведомили писателя.
• FEATURE_SCREENSHOTS=true. Добавляет в интерфейс раздел Скриншоты - мини версия Paint, используемая для быстрого закрашивания чувствительной информации на скриншотах.

Как включить: дополнительные разделы. Назначение: документы, OpenAPI, наблюдение, скриншоты.

Требования

• Установленный Docker Engine и плагин Docker Compose.
• Минимум 1.5 ГБ RAM для работы LanguageTool (Java).
• До 2 ГБ RAM для сервера приложений.
• Свободный порт на хосте (по умолчанию 3080, переменная PROOFREADER_PORT).

Установка

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

При отсутствии .env скрипт копирует .env.example и запускает три контейнера: интерфейс, сервер приложений, проверка языка. Первый запуск занимает около полутора минут. Когда в терминале появится «Готово», откройте http://localhost:3080.

Образы: ghcr.io/badwisher/peter-view/backend и ghcr.io/badwisher/peter-view/frontend. Данные хранятся в томе backend-data.

Устройство

Система состоит из трёх Docker-контейнеров, объединённых в одну внутреннюю сеть. Для внешнего доступа с хоста открыт только один порт - PROOFREADER_PORT (по умолчанию 3080), который слушает nginx.

Когда пользователь открывает интерфейс в браузере, запрос сначала попадает в nginx, а затем перенаправляется к серверу приложения на базе FastAPI. Дальнейшая проверка текста устроена так: инструменты Vale и морфологический анализ работают прямо внутри этого контейнера приложения, а LanguageTool запущен отдельно. Подключение внешней языковой модели происходит опционально - только если администратор явно задал её адрес.

Все данные сохраняются в постоянном Docker-томе backend-data. Когда в интерфейсе раздела «Вычитка» запускается процесс проверки, он инициируется отправкой запроса POST /api/jobs.

Подробности: архитектура, как проходит проверка, хранилище, HTTP API.

Первый запуск

1. Войдите: логин admin, пароль admin.
2. Смените пароль. Меню учётной записи (инициалы слева внизу) → «Сменить пароль». Минимальная длина: 8 символов.
3. Откройте раздел «Вычитка».

4. Вкладка «Текст». Вставьте контрольный фрагмент из установки и первого запуска и нажмите «Начать вычитку».
5. Дождитесь экрана «Очередь решений».
6. Удивитесь качеству вычитки и поставьте звезду репозиторию.

Полная последовательность с тем же фрагментом: установка и первый запуск.

Инструкции: проверка источника, список замечаний, Style Guide, пользователи, языковая модель.

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

Задача	Раздел
Установка и контрольная проверка	Установка и первый запуск
Файл, ссылка или другой текст	Проверка источника
Просмотр замечаний и таблица xlsx	Список замечаний
Пользователи и роли	Пользователи
Вход организации (Keycloak, Azure AD)	OIDC
Имена переменных	Справка .env
Состав стека и путь запроса	Архитектура
Как из кнопки получается список	Проверка
Файлы на томе	Хранилище
HTTP API	Справка API
Зачем система устроена так	Назначение

Полный указатель: документация.

Лицензия

Проект распространяется под лицензией Apache-2.0.
Система не отправляет данные на адрес автора проекта.
Проверка осуществляется локально или через указанные администратором внешние эндпоинты.