Проверки по стайлгайду

Вы можете настроить проверки статей на соответствие корпоративным правилам. Они появятся в приложении каждого редактора.

Модуль проверки по стайлгайду поддерживает два инструмента правил проверки: LanguageTool и LLM.

  • LLM-проверки настраиваются через простые текстовые описания, выполняются с помощью LLM.

  • LanguageTool — это программа для проверки грамматики, орфографии и стилистики, которая поддерживает правила в формате XML.

Настроить правила

  1. В настройках пространства перейдите на вкладку Модули → Стайлгайд.

  2. Если это ваша первая установка, вам будут доступны для включения дефолтные правила

  3. Можно включить существующие правила или создать новые.

Правила LanguageTool

  1. Добавьте правило в разделе «Правила LanguageTool»

  2. Создайте описание правила в формате XML.

  3. Укажите, для каких типов текста следует применять новое правило.

  4. Добавьте и запустите тесты для проверки правила.

  5. Сохраните внесенные изменения.

Правила LLM

  1. Добавьте правило в разделе «Правила LLM»

  2. Напишите название правила.

  3. В поле «Описание» сформулируйте промпт для LLM.

  4. Укажите, для каких типов текста следует применять новое правило.

  5. Добавьте и запустите тесты для проверки правила.

  6. Сохраните внесенные изменения.

Скачать правила из Gramax

  1. В настройках пространства перейдите на вкладку Стайлгайд и скачайте файл настроек.

  2. В него войдут все правила: включенные и выключенные, включая результаты их тестирования.

Загрузить правила из Gramax Check

  1. Перейдите в сервис Gramax Check и откройте настройки правил. Как это сделать — читайте в документации.

  2. Настройте правила и скачайте файл настроек.

  3. В настройках пространства перейдите на вкладку Стайлгайд и загрузите файл настроек.

Пример настроек

LanguageToolRules.json

Проверить статью

Откройте любую статью и в меню статьи выберите Проверить по стайлгайду.