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.

Набор критериев — это рубрика, которую LLM использует при оценке инструкций. Он определяет, как выглядит хорошая инструкция: какие группы качеств проверять и что означает выполнение или нарушение каждой проверки. Doc Reviewer поддерживает несколько наборов критериев, чтобы вы могли поддерживать разные стандарты для разных продуктов, команд или типов документации. В один момент времени активен только один набор, и все оценки используют активный набор. Управление наборами критериев доступно в Настройках → Наборы критериев.

​
Просмотр наборов критериев

Перейдите в Настройки → Наборы критериев, чтобы увидеть все доступные наборы. Активный набор выделен. Нажмите на любой набор, чтобы открыть его и прочитать полное содержимое в формате Markdown.

​
Создание набора критериев

1

Откройте Настройки

Нажмите Настройки в верхней навигации, затем выберите вкладку Наборы критериев.
2

Нажмите «Новый набор критериев»

Нажмите кнопку Новый набор критериев, чтобы открыть редактор.
3

Задайте имя и напишите критерии

Введите название набора, затем напишите или вставьте критерии в формате Markdown. Формат подробно описан на странице Написание пользовательских критериев оценки.
4

Сохраните

Нажмите Сохранить. Новый набор появится в списке, но не будет активным.

​
Активация набора критериев

Нажмите Активировать рядом с набором критериев, который хотите использовать. Ранее активный набор деактивируется автоматически.
Смена активного набора критериев влияет только на новые оценки. Существующие результаты оценки не обновляются ретроактивно. Чтобы применить другой набор критериев к документу, который вы уже оценили, откройте его и запустите оценку заново.

​
Редактирование набора критериев

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

​
Удаление набора критериев

Нажмите Удалить рядом с ненужным набором критериев. Набор по умолчанию (созданный при первом запуске) удалить нельзя. Если вы удаляете активный набор, Doc Reviewer автоматически активирует другой набор из списка.

​
Сброс набора критериев по умолчанию

Если вы отредактировали набор по умолчанию и хотите восстановить его исходное содержимое, нажмите Сбросить на странице набора по умолчанию. Критерии восстановятся из файла criteria.md, поставляемого с приложением.
Набор критериев по умолчанию заполняется из criteria.md при первом запуске Doc Reviewer. Если вы поместили пользовательский файл criteria.md рядом с doc-reviewer.exe до первого запуска, он используется как набор по умолчанию вместо встроенного. Подробнее о формате файла — на странице Написание пользовательских критериев оценки.

​
Формат набора критериев

Критерии написаны в Markdown с определённой структурой. Краткий пример: 
## Роль

You are a technical writer evaluating instruction quality.

---

## Название группы

### 1.1 Название критерия

Описание того, что проверяется и как выглядит прохождение проверки.

### 1.2 Необязательный критерий <опциональный>

Оценивается только при наличии соответствующего раздела в инструкции.
Подробное объяснение формата — включая заголовки групп, нумерацию критериев, маркеры необязательности и раздел Роль — смотрите на странице Написание пользовательских критериев оценки.