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.

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

Группы продуктов

До сохранения снимка вам нужна Группа продуктов для его размещения. Группа продуктов — это именованный контейнер, организующий связанные снимки: как правило, все снимки документации одного продукта для разных версий. Пример: группа с названием «Продукт X» может содержать снимки «v1.0 базовый», «v1.1 после проверки» и «v2.0 релиз». Каждый снимок может быть получен из разного файла документа или URL, но все они принадлежат одному продукту. Группы продуктов не связаны с Проектами. Проекты группируют документы для контекста оценки. Группы продуктов группируют снимки для сравнения.

Сохранение снимка

1

Завершите оценку

Запустите оценку документа и дождитесь её завершения. Хотя бы одна инструкция должна иметь результат оценки, прежде чем вы сможете сохранить снимок.
2

Нажмите «Сохранить снимок»

На странице Оценка документа нажмите Сохранить снимок в заголовке документа или меню действий.
3

Назовите снимок и выберите группу продуктов

В появившемся диалоге:
  • Введите название снимка (например, v1.0 базовый или после проверки в апреле).
  • Выберите существующую Группу продуктов из выпадающего списка или введите новое название группы, чтобы создать её.
Нажмите Сохранить для подтверждения.
4

Перейдите на страницу Снимки

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

Сравните два снимка

Выберите два снимка в группе — или один снимок и текущее состояние оценки исходного документа — и нажмите Сравнить. Открывается вид сравнения «бок о бок».

Что показывает сравнение

Вид сравнения отображает все разделы с инструкциями из обоих снимков рядом, сгруппированные по типу изменения:
ИзменениеЗначение
УхудшилосьЦвет раздела стал хуже (например, зелёный → жёлтый или жёлтый → красный). Показывается первым.
НовоеРаздел есть в более новом снимке, но отсутствует в более старом.
УдаленоРаздел есть в более старом снимке, но отсутствует в более новом.
Без измененийЦвет раздела одинаков в обоих снимках.
УлучшилосьЦвет раздела стал лучше (например, красный → оранжевый или жёлтый → зелёный). Показывается последним.
В сводной панели вверху вида сравнения отображается общее количество по каждому типу изменения.
Сохраняйте снимок сразу после базовой оценки, до внесения каких-либо изменений в документ или критерии. Это даёт чистую точку отсчёта для измерения улучшений.

Управление снимками

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