Проект — верхнеуровневый контейнер в Doc Reviewer. Вы создаёте один проект на продукт, добавляете все документы этого продукта и при желании генерируете контекст продукта — краткое описание, которое LLM читает перед оценкой каждой инструкции. Работа в рамках проектов позволяет организовать документы и сделать результаты оценки точнее и последовательнее.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.
Что содержит проект
Каждый проект хранит:- Название, идентифицирующее продукт (например, «Firewall Manager» или «Identity Console»)
- Необязательный контекст продукта — описание на ~400–700 слов, сгенерированное LLM или написанное вручную
- Все документы, привязанные к этому проекту
Иерархия: проект → документы → инструкции → оценки
Всё в Doc Reviewer строится по этой иерархии:Проект
Группирует документы одного продукта. Хранит контекст продукта, используемый при оценке.
Документы
Файлы или веб-страницы, загруженные в проект. Каждый документ разбивается на разделы.
Инструкции
Разделы, автоматически определённые как инструкции. Эти единицы отправляются в LLM.
Оценки
Результаты по каждой инструкции: цвет, результаты по критериям и рекомендации.
Контекст продукта
Контекст продукта — текстовое описание на ~400–700 слов о документируемом продукте. Он включается в запрос LLM при оценке каждой инструкции в проекте, давая модели фоновую информацию для понимания специализированных терминов, ролей пользователей и названий компонентов. Типичный контекст продукта охватывает:- Название и категорию продукта (например, «сетевое устройство безопасности», «платформа управления идентификацией»)
- Целевую аудиторию и её роли
- 10–15 ключевых терминов и их значение в контексте продукта
- Основные компоненты или подсистемы, упоминаемые в документации
Автоматическая генерация контекста
Doc Reviewer генерирует контекст продукта автоматически, читая не-инструкционные разделы из документов проекта: вводные тексты, разделы глоссария, обзорные страницы и другой справочный материал. Чтобы сгенерировать контекст:Добавьте документы в проект
Загрузите хотя бы один документ, содержащий вводные или справочные разделы. Генератор читает до 60 не-инструкционных разделов из всех документов проекта.
Редактирование контекста вручную
Вы можете написать или отредактировать контекст продукта в любой момент, щёлкнув прямо в поле Контекст продукта на странице проекта. Изменения сохраняются без обновления отметки времени генерации, поэтому вы можете дорабатывать сгенерированный текст, не теряя информацию о том, когда он был создан.Создание проектов и управление ими
Чтобы создать проект, перейдите в Проекты и нажмите Новый проект. Задайте название, которое чётко идентифицирует продукт — оно отображается во всём интерфейсе, включая заголовок документа на экране оценки. Чтобы переименовать проект или обновить его контекст, откройте страницу проекта и отредактируйте поля напрямую.Удаление проекта удаляет все связанные документы и результаты оценки без возможности восстановления. Перед удалением экспортируйте нужные результаты.