Holarch

Требования

Требования

Написание, проверка, утверждение, включение в базовую линию и импорт требований, а также отслеживание открытых элементов TBD/TBR и связей для проверки.

Как использовать →

На этой странице
  1. Обзор
  2. Понятия
    1. Requirement и Statement
    2. Атрибуты требований
    3. Метки требований
    4. Рабочий процесс требований
    5. Открытые пункты: TBD, TBR и TBS
    6. Базовые линии
  3. Как использовать
    1. Когда и зачем
    2. Написать требование
    3. Проверка формулировки
    4. Написание по шаблонам EARS
    5. Утвердить требования
    6. Заморозка документа для рецензирования
    7. Обработка изменения после базовой линии
    8. Закрытие пунктов TBD и TBR
    9. Импорт существующей спецификации
    10. Рабочий пример: демо CubeSat EO-1
    11. Советы и рекомендации
    12. Типичные ошибки
    13. Связь с другими функциями
  4. Страница “Требования”
  5. Качество требований
    1. Макет страницы
    2. Фильтрация страницы “Качество”
    3. Критерии и проверки
    4. Два требования в одном (R19)
    5. Требования на других языках
    6. Ручные переопределения
    7. Устаревшие результаты
    8. Проверка качества из документа
    9. Проверка требований с ИИ
    10. Экспорт качества
  6. Утверждения
    1. Блок утверждений
  7. Реестр TBD/TBR
  8. Ссылки для проверки
    1. Что помечает связь для проверки
    2. Где показываются связи для проверки
    3. Страница “Ссылки для проверки”
  9. Базовые линии и сравнение версий
    1. Базовые линии документов
    2. Сравнение версий
    3. Страница “Базовые линии и версии”
  10. Импорт требований
    1. Шаг 1: файл
    2. Шаг 2: сопоставление
    3. Шаг 3: проверка
    4. Как читается каждый формат
    5. Обновление требований из электронной таблицы
    6. Сообщения импорта
  11. Сочетания клавиш для требований
  12. Настройки
  13. Сообщения
  14. Ограничения
  15. Связанные материалы

Обзор

Страницы требований служат для написания, проверки, утверждения требований и создания для них базовых линий, а также для отслеживания того, что ещё открыто. Требование — это сущность класса LML Requirement: возможность, характеристика или фактор качества, которыми должна обладать система.

Требования обычно находятся в документе требований (см. Документы). Каждое из них при этом остаётся сущностью модели. Поэтому одно и то же требование появляется в базе данных, на диаграммах, в матрице прослеживаемости и в RVTM.

Группа Потребности и требования на панели навигации содержит все страницы требований:

СтраницаЧто показывает
ДокументыСпецификации и их структура. Здесь пишутся требования.
ТребованияВсе требования в одной таблице (база данных с фильтром class:Requirement).
КачествоКачество требований: оценка по девяти критериям для каждого требования.
TBD/TBRРеестр открытых значений, которые ещё предстоит определить или проверить.
Ссылки для проверкиСвязи, вышестоящее требование которых изменилось после последней проверки связи.
УтвержденияТребования со статусом In Review.
Импорт и экспортИмпорт из Word, Excel, CSV, ReqIF, простого текста, XMI и файлов проекта через одну зону перетаскивания, а также экспорт модели.

Базовые линии — замороженные снимки для рецензирования. Создавайте их из документа или на странице Контроль и рецензирование → Базовые линии и версии. Связи с функциями, ресурсами и тестами описаны в разделе Прослеживаемость.

Понятия

Requirement и Statement

Statement — родительский класс для Requirement.

  • Используйте Statement для необязывающего текста: заголовков разделов, допущений, контекста.
  • Используйте Requirement для каждого обязывающего утверждения со словом “shall” (должен).

Только объекты Requirement оцениваются проверкой качества, попадают в реестр TBD/TBR, помечаются для проверки при изменении и учитываются в RVTM. Statement пропускаются.

У требования есть общие поля сущности Номер, Имя и Описание. Описание — это сама формулировка требования в виде форматированного текста. Остальное добавляют атрибуты ниже.

Атрибуты требований

АтрибутТип и значенияЗначение
ОбоснованиеДлинный текстПричина, стоящая за требованием.
СтатусDraft, In Review, Approved, RejectedПоложение требования в рабочем процессе утверждения.
PriorityHigh, Medium, LowНасколько требование важно для заинтересованных сторон.
CriticalityHigh, Medium, LowПоследствия для миссии или безопасности, если требование не выполнено.
ВладелецТекстЧеловек или команда, отвечающие за требование.
ИсточникТекстЗаинтересованная сторона, документ или стандарт, из которых происходит требование.
Verification MethodМножественный выбор: Analysis, Demonstration, Inspection, TestКак верифицируется требование.
Verification LevelComponent, Subsystem, SystemУровень сборки, на котором верифицируется требование.
Success CriteriaДлинный текстИзмеримый результат, показывающий, что требование выполнено.
TBD/TBRNone, TBD, TBRTBD — значение ещё предстоит определить; TBR — значение предстоит проверить. При закрытии верните None.
TBD OwnerТекстЧеловек, отвечающий за закрытие TBD/TBR.
TBD Due DateДата и времяДата, к которой TBD/TBR должен быть закрыт. Срок в группе Рабочий процесс показывает и задаёт ту же дату (см. Реестр TBD/TBR).
Quality ScoreПроцент, вычисляетсяРезультат последней проверки качества.
Appropriate, Complete, Conforming, Correct, Feasible, Necessary, Singular, Unambiguous, VerifiableДа/Нет, вычисляется или задаётся вручнуюДевять критериев качества.

Инспектор группирует поля требования (см. Инспектор): Requirement (Number, Name, Description, Labels, Rationale, Source, Success Criteria), Рабочий процесс (полоса рецензирования со Status, Priority, Criticality, Owner, Assignee, сроком, TBD/TBR, TBD Owner, TBD Due Date), Верификация (Verification Method и Level, Verified by и поля закрытия с формальной программой), Значения (Budget Quantity, Threshold, Objective и текущее Value, Units), Соответствие (формальная программа) и Качество.

Оценка и девять критериев находятся в группе Качество, сначала свёрнутой. Её заголовок гласит, например, “89% · 8 of 9 met” (89 % · выполнено 8 из 9) или “not checked yet” (ещё не проверено). Holarch запоминает для каждого класса, оставили ли вы группу открытой.

Проекты могут добавлять собственные атрибуты требований и варианты; см. Расширения схемы.

Метки требований

Метки классифицируют требования, не меняя их класс. Встроенные метки требований:

  • Functional Requirement, Performance Requirement, Требование к интерфейсу.
  • Environmental Requirement, Reliability Requirement, Safety Requirement.
  • Verification Requirement.
  • Stakeholder Need: потребность, заявленная заинтересованной стороной, до того как она превращена в системные требования.

Verification Method — также группа меток с метками Analysis, Demonstration, Inspection и Test. Метка и атрибут синхронизируются в одном шаге отмены:

  • Добавление метки Test задаёт Verification Method = Test.
  • Выбор Test в атрибуте добавляет метку.

Старые проекты и импорты, содержащие только метки, объединяются с атрибутом при открытии проекта.

Рабочий процесс требований

Каждое требование проходит четыре статуса:

  1. Draft: пишется.
  2. In Review: ожидает решения. Отображается на странице “Утверждения”.
  3. Approved или Rejected: решение принято. Каждое решение фиксирует, кто его принял, когда и необязательную причину.

После утверждения три механизма сохраняют запись честной:

  • Повторное рецензирование при правке. Изменение имени или описания требования со статусом Approved возвращает его в In Review с пометкой “Text changed after approval” (текст изменён после утверждения).
  • Устаревшее качество. Изменение имени или описания помечает результаты качества как устаревшие и очищает ручные переопределения качества.
  • Связи для проверки. Изменение имени, описания или ключевого атрибута помечает для проверки связи с нижестоящими элементами.

Все три входят в правку, поэтому одно нажатие “Отменить” (⌘Z / Ctrl+Z) отменяет их вместе.

Открытые пункты: TBD, TBR и TBS

Открытый пункт — это значение, которое ещё не определено. Требование является открытым пунктом, если выполняется любое из условий:

  • Его атрибут TBD/TBR равен TBD или TBR.
  • Его имя или описание содержит слово TBD, TBR или TBS.

Открытые пункты показываются в реестре TBD/TBR, пока не будут закрыты.

Базовые линии

Базовая линия — это снимок только для чтения. Есть два вида:

  • Базовая линия документа содержит один документ. В неё входят артефакт документа, его элементы и их атрибуты, связи, которые их касаются, сущности на расстоянии одного шага и настройки структуры документа.
  • Базовая линия проекта содержит все сущности и связи проекта.

Базовые линии могут содержать записи об утверждении (имя, роль, заявление, дата). После сохранения записи блокируются.

Как использовать

Когда и зачем

Работа с требованиями охватывает левую сторону V-модели системной инженерии:

  1. Сбор потребностей заинтересованных сторон.
  2. Выведение системных требований.
  3. Проверка правильности формулировки каждого утверждения.
  4. Утверждение требований.
  5. Заморозка их на рецензировании (SRR, PDR, CDR).

После базовой линии работа переходит к управлению изменениями. Каждое изменение рецензируется заново, а его влияние на нижестоящие элементы проверяется. Открытые значения TBD/TBR закрываются до фиксации проекта.

Страницы требований отвечают на такие вопросы:

ВопросСтраница
Хорошо ли написано каждое требование?Качество
Какие значения ещё неизвестны, кто за них отвечает и не просрочены ли они?TBD/TBR
Что нужно перепроверить, потому что изменилось требование?Ссылки для проверки
Что ожидает решения?Утверждения
Что изменилось после рецензирования?Версия ▾ → Сравнить версии… документа, Базовые линии и версии
Распределено ли и верифицировано ли каждое требование?Матрица прослеживаемости и RVTM

Страницы “Качество”, “Ссылки для проверки”, “TBD/TBR” и “Утверждения” находятся рядом друг с другом в группе Потребности и требования на панели навигации. Пройдите оттуда все четыре проверки по очереди.

Написать требование

  1. Откройте Потребности и требования → Документы.
  2. Откройте документ требований.

    Чтобы начать новый, нажмите + Новый документ (см. Документы).

  3. В строке Быстрое добавление под документом выберите, куда пойдёт элемент, например Под 3 Electrical Power.
  4. Введите формулировку требования и нажмите Enter.

    Holarch добавляет элемент класса документа по умолчанию (Requirement в документе требований). Он нумеруется после соседних элементов.

  5. Выбрав требование, откройте инспектор справа.
  6. Заполните Rationale, Source и Success Criteria в группе Requirement, Priority, Criticality и Owner в группе Рабочий процесс, а также Verification Method и Verification Level в группе Верификация.
  7. Добавьте метку типа кнопкой + Метка в группе Requirement инспектора, например Performance Requirement. (Столбец Метки находится в Вид ▾ → Столбцы ▸.)

Требование получает Status Draft и появляется на странице Потребности и требования → Требования.

Если значение ещё неизвестно:

  1. Запишите в формулировку свою лучшую оценку.
  2. Задайте TBD/TBR = TBD.
  3. Заполните TBD Owner и задайте дату в поле Срок группы Рабочий процесс.

    Теперь требование также появляется в реестре TBD/TBR с этим сроком.

Проверка формулировки

  1. Откройте Потребности и требования → Качество.

    Из документа вместо этого выберите Проверить ▾ → Проверить качество.

  2. В строке области выберите Все требования или Документ: <имя>.
  3. Нажмите Проверить качество в заголовке страницы.

    Уведомление сообщает “Checked 32 requirements” (проверено 32 требования, или ваше число). Каждое требование получает оценку от 0 до 100 % и ✔ или ✘ по каждому критерию.

    При более чем 2000 требованиях проверка выполняется в фоне: карточка хода выполнения показывает “Checking requirements” (проверка требований), число и оставшееся время, а вы можете продолжать работу. Нажмите Отмена на карточке, чтобы остановить; ничего не изменится. Затем карточка показывает “Saving the quality results” (сохранение результатов качества) с числом сохранённых; во время сохранения другие правки отклоняются с сообщением “Saving the quality results. Try again when it finishes.” (Сохраняются результаты качества. Повторите попытку после завершения.) Сохраняются только требования, результаты которых изменились, поэтому повторная проверка без изменений ничего не сохраняет. Вся проверка — один шаг: одно нажатие ⌘Z / Ctrl+Z отменяет её.

  4. Прочитайте плитки: Требования, Средняя оценка, Хорошо (≥ 67%), Требует доработки (< 67%) и, если такие есть, Устарело (текст изменён).
  5. Для каждого требования ниже 67 % прочитайте столбец Предложения.

    Или наведите указатель на ✘, чтобы увидеть сообщения по этому критерию.

  6. Щёлкните имя требования, чтобы открыть его, и исправьте текст.
  7. Запустите проверку снова.

Correct и Feasible всегда требуют суждения человека. Проверка никогда не отмечает их выполненными, что бы ни нашли другие проверки. Поэтому автоматическая проверка достигает не больше 7 из 9 критериев (78 %). Требование без верифицирующего теста или требования достигает 6 из 9 (67 %). Для каждого требования решите их сами:

  • Проверив требование, щёлкните ✘, чтобы отметить критерий как Yes.
  • Для первого мнения используйте ✦ ИИ ▾ → Проверить с ИИ (N требований)… (проверка требований с ИИ).

Примечание: оценки, сохранённые прежними версиями, могли считать Correct или Feasible выполненными, когда другая проверка не проходила. Запустите проверку снова, чтобы обновить их.

Написание по шаблонам EARS

EARS (Easy Approach to Requirements Syntax) записывает каждое требование одним предложением: необязательное условие, затем “the [system] shall [response]”. Первое слово условия задаёт шаблон.

ШаблонОбразецПример
UbiquitousThe [system] shall [response].The pump controller shall record every start command with its time.
Event-drivenWhen [trigger], the [system] shall [response].When the tank level falls below 20 %, the pump controller shall start the backup pump.
State-drivenWhile [state], the [system] shall [response].While the vehicle is charging, the battery manager shall keep each cell below 45 °C.
Unwanted behaviorIf [unwanted condition], then the [system] shall [response].If the supply voltage drops below 10 V, then the flight computer shall switch to the reserve battery.
Optional featureWhere [feature is included], the [system] shall [response].Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes.
ComplexWhile [state], when [trigger], the [system] shall [response].While the drill is in standby, when the operator presses Start, the drill controller shall reach full speed within 3 s.
  1. Откройте требование в инспекторе или представлении элемента.
  2. Нажмите EARS ▾ рядом с Описание.

    Первая строка показывает шаблон утверждения (✓ Event-driven) или что нужно исправить (Нет шаблона EARS: исправить 1).

  3. Выберите шаблон.

    Его образец становится описанием. Если у требования уже есть описание, подтвердите кнопкой Заменить; старое утверждение остаётся в истории элемента. Одно нажатие ⌘Z / Ctrl+Z отменяет это.

  4. Замените слова в квадратных скобках.

Чтобы проверять все требования, задайте для Requirement.11 уровень Предупреждение или Ошибка в Проверки модели → Настройки. По умолчанию правило выключено.

В проекте SysML v2 EARS ▾ находится под Документация требования в инспекторе и записывает его doc-комментарий.

Утвердить требования

  1. Когда требование готово, задайте для него Status = In Review.

    Сделайте это в инспекторе (Status в полосе рецензирования группы Рабочий процесс), в базе данных или в столбце документа.

  2. Рецензент открывает Потребности и требования → Утверждения.

    Страница перечисляет все требования со статусом In Review.

  3. Щёлкните строку.

    Группа Рабочий процесс инспектора показывает полосу рецензирования: Status, кто и когда его задал (“by J. Rivera · Mar 9, 2026 at 9:58 AM”), и кнопки.

  4. Нажмите Утвердить.

    Или нажмите Отклонить… и при желании введите причину.

    Уведомление сообщает “Утверждено” или “Отклонено”. Решение фиксируется с вашим именем и временем, и требование покидает список утверждений.

    Если требование входит в базовую линию и на него ссылаются элементы верификации или документы, Утвердить сначала открывает диалог, перечисляющий их в разделе Требует повторного рецензирования (Влияние). Щёлкните строку, чтобы посмотреть её, затем нажмите Утвердить для подтверждения.

Чтобы вернуть решённое требование на рецензирование, нажмите Открыть снова. Уведомление сообщает “Перемещено в In Review”.

Если в проекте есть рабочий процесс по Status требований (Схема → Рабочий процесс), полоса рецензирования показывает переходы этого рабочего процесса вместо Утвердить, Отклонить… и Открыть снова. Переход, требующий утверждения, заканчивается на … и открывает Запросить утверждение: см. Запрос утверждения смены состояния. Для требования в базовой линии Запросить утверждение и диалог Утвердить… запроса на изменение показывают тот же список Требует повторного рецензирования.

Заморозка документа для рецензирования

  1. В штампе документа нажмите Версия ▾.
  2. Выберите Сохранить базовую линию….

    Или выберите Поставка ▾ → Версия ▸ Сохранить базовую линию….

  3. Оставьте или измените Имя. По умолчанию — “<документ> Baseline <n>”.
  4. В разделе Утверждения заполните по строке на каждого утверждающего: Имя, Роль и Заявление (по умолчанию “Approved for release.”).

    + Добавить утверждающего добавляет строку; × удаляет её.

  5. Нажмите Создать.

    Уведомление сообщает “Базовая линия сохранена”. Версия ▾ показывает “Текущая · последняя базовая линия <имя>”.

С этого момента каждая строка, отличающаяся от последней базовой линии, получает полосу изменения.

Обработка изменения после базовой линии

  1. Измените текст требования в документе.

    Уведомление кратко сообщает, что произошло, например “1 утверждённое требование перемещено в In Review; 6 связей отмечено для рецензирования.” В рамках вашей правки (одно нажатие “Отменить” возвращает всё назад):

    • Требование со статусом Approved переходит в In Review.
    • Его результаты качества устаревают (“Качество: устарело — запустите снова”).
    • Его нижестоящие связи помечаются для проверки.
  2. Откройте Потребности и требования → Ссылки для проверки.
  3. Для каждой строки нажмите Сравнение, чтобы увидеть изменение текста, и проверьте связанный элемент.
  4. Если связанный элемент по-прежнему верен, нажмите Отметить как проверенное… в его строке.

    Чтобы отметить несколько сразу, выберите их строки и нажмите Отметить выбранные как проверенные….

  5. Запишите, что вы проверили, и нажмите Отметить как проверенное.
  6. Снова запустите проверку качества.
  7. Снова отправьте требование на утверждение.
  8. Нажмите Версия ▾ → Сравнить версии…, выберите базовую линию в поле От и Текущая версия в поле До.

    Отчёт перечисляет все изменения с момента базовой линии.

  9. Нажмите Изменения (Excel) для совета по изменениям.

Закрытие пунктов TBD и TBR

  1. Откройте Потребности и требования → TBD/TBR.
  2. Прочитайте плитки: Открытые TBD/TBR, Просрочено, Без владельца и число по каждому документу.
  3. Сначала разберитесь с просроченными строками. Они выделены цветом, с пометкой “Просрочено” под сроком.
  4. Где владелец показан как “—”, назначьте TBD Owner.
  5. Когда значение определено, исправьте текст требования на окончательное значение.
  6. Нажмите Закрыть в строке.

    “Закрыть” задаёт TBD/TBR = None, и строка покидает реестр.

Чтобы отправить реестр владельцам, нажмите Экспортировать XLSX.

Импорт существующей спецификации

  1. Откройте Потребности и требования → Импорт и экспорт.
  2. Перетащите файл в зону перетаскивания или щёлкните её, чтобы выбрать файл: Word (.docx), Excel или CSV, ReqIF или простой текст.

    Строка состояния сообщает, например, “Проанализирован “SRS.docx”: 48 строк, 5 столбцов.” Формат показывает распознанный формат.

  3. Нажмите Продолжить.
  4. Проверьте, с чем сопоставлен каждый столбец, и задайте Класс для строк без класса = Requirement.
  5. Нажмите Продолжить.
  6. Оставьте отмеченным Создать документ требований из этих N требований, проверьте тип и имя документа, а также новые и обновлённые элементы и предупреждения.
  7. Нажмите Импортировать N элементов.

    Если предупреждений нет, Holarch открывает новый документ. Если есть, их перечисляет карточка Импорт завершён.

На карточке Импорт завершён есть кнопки для открытия документа, базы данных, диаграммы Spider или древовидной диаграммы либо проверки качества. Одно нажатие ⌘Z / Ctrl+Z отменяет весь импорт.

Рабочий пример: демо CubeSat EO-1

Создайте демо-проект CubeSat EO-1 — Earth Observation Demo в разделе Управление проектами. В нём есть спецификация из 32 требований, SRS-001 EO-1 System Requirements Specification, с базовой линией SRR и изменениями после неё.

Качество.

  1. Откройте Потребности и требования → Качество и нажмите Проверить качество.

    Плитки показывают 32 требования, среднюю оценку 92 %, 29 “Хорошо” и 3 “Требует доработки”.

Три слабых требования написаны так намеренно. Каждое получает 44 %:

  • 2.5 Safe Mode Recovery: “The spacecraft should recover from safe mode quickly and resume imaging as appropriate”. Среди предложений:
    • “R34 - Показатели производительности, которые нельзя измерить: [quickly]”
    • “R8 - Оговорки ослабляют требование: [as appropriate]”
    • “R19 - Объединяет два требования; разделите на отдельные требования: [and]”
    • “Завершите утверждение точкой.”
    • “Свяжите Test Case или Requirement, который его верифицирует.”
  • 3.5 Battery Thermal Control: “…keep the battery warm enough (TBD).” Предложения: “R21 - Содержит скобки; перенесите текст в скобках в Rationale.” и “Замените заполнители TBD/TBR.”
  • 6.4 Operator Interface: “…shall be user friendly and/or easy to use.” Предложения: “R34 - Показатели производительности, которые нельзя измерить: [user friendly, easy to use]” и “R19 - “и/или” неоднозначно; укажите, имеются ли в виду оба или один: [and/or]”.

Чтобы исправить 2.5:

  1. Перепишите его как “The spacecraft shall resume imaging within 6 hours of a safe mode entry.”
  2. Свяжите тестовый случай связью verified by.
  3. Запустите проверку снова.

    Сообщения о соединителе, оговорке и расплывчатом термине исчезают.

TBD/TBR. Откройте TBD/TBR. Там три открытых пункта:

  • 3.5 Battery Thermal Control: TBD, за который отвечает Thermal Engineer. Он просрочен.
  • 2.4 Target Slew (ADCS Lead) и 5.3 Downlink Link Margin (Comms Lead): TBR с более поздним сроком.

Изменение после базовой линии. Версия ▾ документа перечисляет SRR Baseline. Её утвердили J. Rivera (Systems Lead), R. Okafor (Mission Principal Investigator) и L. Brandt (Program Manager).

После SRR требование 3.1 Orbit Average Power изменилось с 28 W на 30 W. Поскольку 3.1 имело статус Approved, оно вернулось в In Review с пометкой “Текст изменён после утверждения”.

Ссылки для проверки перечисляет шесть связей от 3.1:

  • 1.3.1 Solar Arrays
  • F3 Generate and Store Power и F3.1 Convert Sunlight to Power
  • EQ-1.1 Solar Power Generation и EQ-1.4 Power Margin Check
  • TC-06 Solar Array Power Test

Нажмите Сравнение в любой строке: “28 W” зачёркнуто, а “30 W” вставлено. Затем проверьте элементы:

  • TC-06 ожидает пиковую мощность ≥ 72 W а измерено 75,1 W. Через EQ-1.3 Orbit-Average Array Power (пик × 0,62 доли освещённости × 0,6 КПД тракта питания) 75,1 W дают 27,9 W в среднем по орбите — ниже новых 30 W. Оставьте эту связь непроверенной и добавьте комментарий “75.1 W peak = 27.9 W orbit average; re-test against about 80.6 W peak”. Тесту нужны новый ожидаемый результат и новый прогон.
  • Прежде чем отметить 1.3.1 как проверенное, убедитесь, что расчёт солнечной батареи по-прежнему сходится.

Сравнить с текущей. Выберите SRR Baseline в Версия ▾, затем нажмите Сравнить с текущей в её баннере. Отчёт перечисляет:

  • Изменения Description, Rationale, Status и Quality Score у 3.1.
  • Изменение Status у 2.4 Target Slew (Draft → In Review).
  • Новое требование 4.4 Downlink Encryption с двумя новыми связями satisfies.

Утверждения. Откройте Утверждения. Девять требований находятся в статусе In Review, включая 3.1, 1.5 Daily Collection Volume и 5.3 Downlink Link Margin.

Советы и рекомендации

  • Пишите одно “shall” на требование, в действительном залоге, с числом, единицей и условием. Проверка качества поощряет именно это.
  • Помещайте причину в Rationale, а не в утверждение. Обороты цели (“so that”, “in order to”) и скобки помечаются как R20 и R21.
  • Заполняйте Verification Method при написании. Тогда требование с методом, но без тестового случая показывается в RVTM как “Только запланировано”, а не “Не верифицировано”.
  • Задавайте TBD/TBR с владельцем и сроком, а не только пишите “TBD” в тексте. Атрибут даёт реестру владельца и срок для отслеживания.
  • Создавайте базовую линию перед каждым рецензированием. Полосы изменений и Сравнить с текущей работают только относительно базовой линии.
  • Отмечайте связи проверенными с комментарием. Комментарий добавляется к связанному элементу и записывается в связи, поэтому проверка оставляет журнал аудита.

Типичные ошибки

СимптомПричинаИсправление
Требование не оценивается, не попадает в реестр или отсутствует в RVTM.Это Statement, а не Requirement.Смените его класс на Requirement в инспекторе.
Correct и Feasible показывают ✘ у каждого требования.Им нужно суждение человека (“Нужно суждение рецензента”).Проверьте каждое и щёлкните ✘, чтобы отметить Yes, или запустите проверку требований с ИИ.
Оценка показывает “Устарело — запустить снова”.Текст изменился после последней проверки.Нажмите Проверить качество или включите Повторно проверять автоматически при изменении текста.
Ручные переопределения Yes/No исчезли.Их очищает правка текста.Задайте их снова после проверки; отмена восстанавливает их, и они остаются в истории.
Требование вышло из статуса Approved после исправления опечатки.Любая правка имени или описания снова открывает утверждённое требование.Утвердите его снова. Исправляйте опечатки до утверждения.
В строке TBD/TBR нет кнопки “Закрыть”.Открытый пункт возникает только из текста.Исправьте текст, чтобы убрать TBD, TBR или TBS.
Импорт создал копии вместо обновления.Сопоставлять существующие сущности по не нашло совпадений.Экспортируйте со столбцом ID, измените и импортируйте с Сопоставлять существующие сущности по: Глобальный ID (см. Обновление требований из электронной таблицы).

Связь с другими функциями

  • Получает данные из: исходных данных заинтересованных сторон и существующих спецификаций через Импорт, а также документов, написанных в Документах.
  • Передаёт данные в:
  • ИИ: меню ✦ ИИ ▾ документа и представления элемента содержит пункты “Переписать ясно…”, “Добавить измеримые критерии…”, “Упростить…”, “Разделить составное требование…”, “Набросать обоснование…”, “Предложить имя…” и “Проверить с ИИ” (проверка требований с ИИ). Изменения ИИ показываются в предпросмотре до применения. См. Спросить ИИ и инструменты ИИ.

Страница “Требования”

Используйте страницу “Требования”, чтобы видеть и изменять все требования в одной таблице. Потребности и требования → Требования — это база данных с фильтром class:Requirement.

Здесь работают все функции базы данных:

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

Щёлкните строку, чтобы показать требование в инспекторе. Дважды щёлкните, чтобы открыть его представление элемента. Требование со связью на проверку показывает в строке значок ⚠ Рецензировать. Щёлкните строку правой кнопкой, чтобы открыть её меню: до трёх предлагаемых действий с причинами (например, ✦ Добавить измеримые критерии…, когда требование не проходит Unambiguous, ✦ Сгенерировать тестовый случай…, когда оно не верифицировано), ✦ Ещё ИИ ▸, затем Открыть, Переименовать…, Дублировать, Добавить дочерний…, Status ▸, Priority ▸, Связать с ▸, Добавить в документ ▸, Показать на диаграмме ▸, Копировать ссылку, Копировать номер и Удалить… (см. Контекстное меню).

О таблице, запросах и массовой правке см. Модель и база данных.

Полезные запросы:

ЗапросПоказывает
class:RequirementВсе требования.
Requirement:"Status=In Review"Список утверждений.
Requirement:"Status=Draft"Требования, ещё не отправленные на рецензирование.
class:Requirement AND is:leafЛистовые требования (без дочерних требований).
class:Requirement AND NOT relationship:"verified by"Требования без верифицирующего элемента.

Качество требований

Используйте страницу Качество (заголовок “Качество требований”), чтобы найти плохо сформулированные требования. Она оценивает каждое требование по девяти критериям.

Девять критериев и номера правил в предложениях (R2, R19 и т. д.) следуют характеристикам и правилам руководства INCOSE Guide to Writing Requirements. Списки слов и шаблоны Holarch приближают эти правила; это не текст руководства, и некоторые правила требуют суждения рецензента.

  • Оценка = 100 × (выполненные критерии) / 9 с округлением. Непроверенный критерий (–, см. Требования на других языках) не учитывается: 100 × выполненные / 8.
  • 67 % и выше — Хорошо. Ниже 67 % — Требует доработки.
  • Полоса красная ниже 34 %, жёлтая от 34 % до 66 % и зелёная от 67 %.

Макет страницы

  • Заголовок страницы:
    • Ещё ▾: Очистить ручные оценки сбрасывает все ручные Yes/No у показанных требований и запускает проверку снова. Открыть в «Требованиях» открывает показанные требования в таблице “Требования”. Открыть документ появляется, когда областью является документ.
    • Экспорт ▾: Excel (.xlsx) и CSV по показанным требованиям.
    • Проверить качество: проверяет все требования области, что бы ни показывали фильтры (правило дубликатов сравнивает каждое требование с остальными в области).
  • ✦ ИИ ▾ (на верхней панели): Проверить с ИИ (N требований)… — проверка с ИИ показанных требований.
  • Строка области: Область (Все требования или Документ: <имя>) и флажок Повторно проверять автоматически при изменении текста. Ссылки для проверки, TBD/TBR и Утверждения находятся рядом с Качество на панели навигации.
  • Строка запроса: + Фильтр, чипы фильтров и текст поиска, Очистить, ? (синтаксис поиска) и Представления ▾ — та же строка, что на странице “Требования” (см. Фильтрация страницы “Качество”).
  • Плитки: Требования (“12 из 40” под Показанные требования, когда фильтры скрывают часть), Средняя оценка, Хорошо (≥ 67%), Требует доработки (< 67%) и Устарело (текст изменён), если есть устаревшие. Устаревшие оценки не учитываются в среднем.
  • Примечание под плитками: “Автоматические проверки охватывают не более 7 из 9 атрибутов (78%); Correct и Feasible требуют проверки человеком — нажмите ✘, чтобы отметить “Да”. Каждый щелчок переключает ручное “Да”, ручное “Нет” и возврат к автоматическому.”
  • Таблица: Номер, Имя (с описанием ниже), Оценка качества, по столбцу на критерий и Предложения. “Предложения” перечисляет все сообщения с префиксом критерия. Строки отсортированы по номеру. Щёлкните строку правой кнопкой или нажмите на ней Shift+F10, чтобы открыть меню строки базы данных: предлагаемые действия с причинами (первой идёт переформулировка, исправляющая невыполненный критерий), ✦ Ещё ИИ ▸, Открыть, Переименовать…, Дублировать, Добавить дочерний…, Status ▸, Priority ▸, Связать с ▸, Добавить в документ ▸, Показать на диаграмме ▸, Копировать ссылку, Копировать номер и Удалить…. Строка становится выделением.
  • Несколько строк: щелчок с ⌘ / Ctrl (Ctrl-щелчок в Windows и Linux) переключает строку, щелчок с ⇧ / Shift выбирает диапазон от последней щёлкнутой строки, щелчок с ⌘ / Ctrl+⇧ / Shift добавляет этот диапазон, а ⌘A / Ctrl+A или ⇧ / Shift+↑ / ⇧ / Shift+↓ на строке с фокусом выбирают все строки или расширяют выделение. Панель инструментов показывает число; Esc снимает выделение. Щёлкните выбранную строку правой кнопкой, чтобы действовать на все: ✦ Проверить с ИИ (n требований)…, ✦ Переписать (n) ▸, ✦ Сгенерировать тестовые случаи (n)…, ✦ Спросить ИИ об этих (n)…, ✦ Предложить трассы (n)… (каждое с одним предпросмотром; см. ИИ для нескольких выбранных элементов), Дублировать n сущностей, Задать Status ▸, Задать Priority ▸, Добавить в документ ▸ и Удалить n элементов…; каждое отменяется одним нажатием “Отменить”. Реестр TBD/TBR и “Ссылки для проверки” работают так же; в “Ссылках для проверки” выделение также отмечает строки для Отметить выбранные как проверенные….

Особые случаи:

  • Строка без результата показывает “Не запускалось” в столбце оценки.
  • Устаревшая строка показывает “Устарело — запустить снова”.
  • Если в области нет требований, страница показывает “Нет требований” и “Оцениваются только сущности класса Requirement; Statement пропускаются.”
  • Если фильтры или текст поиска скрывают все требования, страница показывает “Нет подходящих требований” и “Нет требований, соответствующих поиску или фильтрам. Очистите их, чтобы увидеть все требования.”

Фильтрация страницы “Качество”

Строка запроса работает так же, как на странице “Требования” (см. Как введённые фильтры становятся чипами): введённые условия фильтра становятся чипами при нажатии Enter, остальной текст сопоставляется с именем, номером и описанием, Backspace в пустом поиске удаляет последний чип, а Очистить удаляет все. Плитки, таблица, Экспорт ▾ и ✦ ИИ ▾ → Проверить с ИИ следуют фильтрам.

+ Фильтр перечисляет, с числами для области:

ГруппаФильтрыУсловие
КачествоХорошо (≥ 67%), Требует доработки (< 67%), Не запускалось, Устарело (текст изменён), Ручные оценки, Замечание ИИquality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai
Не проходит критерийПо одному на критерий: оценка Noquality:Verifiable=no (=yes: оценка Yes)
Замечание по правилуПравила, найденные в области, например R7 Неточная формулировка или R30 Очень похоже (возможные дубликаты)quality:R7
Структура, Класс, Атрибуты требования, Метка, Связь, ДиаграммаКак на странице “Требования”; атрибуты требования перечислены без чипа классаis:tbd, Requirement:"Status=Draft", label:"…"

Фильтры одной группы объединяются через или; разные группы — через и. Диапазоны оценки используют атрибут: Requirement:"Quality Score>=50". Условия quality: работают и на странице “Требования”, и в базе данных.

Представления ▾ применяет встроенное представление (Требует доработки, Ещё не проверено, Устаревшие результаты, Неоднозначно, Не верифицируемо, Возможные дубликаты, Ручные оценки) или одно из ваших сохранённых. Сохранить представление… сохраняет текущие фильтры и текст поиска в этом браузере для всех проектов; Удалить “<имя>” появляется, пока используется сохранённое представление. Все требования очищает фильтры. Адрес quality?q=<query> открывает страницу с фильтром.

Фильтрация читает сохранённые результаты и не проверяет заново. На 50 000 требований смена фильтра или поиска занимает намного меньше десятой доли секунды.

Критерии и проверки

Каждый критерий показывает одну из трёх отметок:

  • ✔ (Yes): сообщений нет.
  • ✘ (No): хотя бы одно сообщение.
  • –: не проверено.

Проверки сопоставляют целые слова и фразы без учёта регистра. Учитываются только перечисленные формы: “effective” и “effectively” обе в списке, “effectiveness” — нет. Слова в кавычках тоже учитываются. Сообщения ниже — точный показываемый текст. Список в скобках в конце сообщения называет найденные слова.

Unambiguous

ПравилоСообщениеСрабатывает на
R6R6 - Нераспознанные единицы; используйте стандартные единицы SI, американские или имперские: [...]Число, за которым следует слово, не являющееся известной единицей (например, “12 sorties”). К известным единицам относятся единицы SI, американские и имперские единицы и их сокращения, %, градусы, °C и °F.
R2R2 - Используйте действительный залог: [...]“shall/must/will/should be”, за которым следует причастие прошедшего времени (“shall be measured”).
R5R5 - Используйте определённые формулировки (“этот”) вместо: [...]“a” или “an”.
R7R7 - Неточная формулировка: [...]some, many, several, few, little, much, various, appropriate(ly), adequate(ly), efficient(ly), effective(ly), sufficient(ly), reasonable, reasonably, suitable, suitably, significant(ly), minimal(ly), maximal(ly), approximately, almost, nearly, generally, usually, typically, normally, robust(ly), flexible, flexibly, easy, easily, etc, similar, relevant, substantial(ly), large, small, good, bad, better, best, worst, proper, properly, acceptable, acceptably, accurate(ly), extreme, high-contrast, high contrast.
R8R8 - Оговорки ослабляют требование: [...]if necessary, where possible, as appropriate, as practicable, as far as possible, if practical, as required, as needed, to the extent possible, if possible.
R10R10 - Лишние обороты с инфинитивом: [...]to be designed to, to be able to, to be capable of, to enable, to allow, be able to, be capable of.
R16R16 - Избегайте отрицания: [...]not, n't, never.
R17R17 - Избегайте косой черты (“/”).Косая черта между двумя словами, кроме km/h, m/s, and/or и его аналогов в немецком, французском, испанском, итальянском и нидерландском.
R24R24 - Местоимения вместо явных существительных: [...]it, its, they, them, their, he, she, him, her, someone, something, anyone, anything, anybody, somebody, this, these, those.
R32R32 - Используйте слово “каждый” вместо кванторов всеобщности: [...]all, any, both, every, everything, everyone.
R34R34 - Показатели производительности, которые нельзя измерить: [...]fast, quick, quickly, user friendly, user-friendly, high speed(s), high-speed, best practice(s), state of the art, state-of-the-art, seamless(ly), intuitive(ly), easy to use, timely, rapid, rapidly, real-time, real time. “Real-time clock” не учитывается: это название компонента.
R35R35 - Нечёткие слова о времени: [...]as, eventually, before, after, until, meanwhile, simultaneous(ly), soon, later, sometimes, occasionally, often, subsequently, previously.
—Замените заполнители TBD/TBR.TBD, TBR или TBS в описании (прописными буквами).
—AI: ambiguous — <причина>Принятое замечание ИИ из проверки требований с ИИ.
—Указывает максимум (“до”); если имеется в виду минимум, используйте “не менее”.“up to”, за которым следует число цифрами или словами (“up to 72 hours”, “up to five tonnes”). “Up to date” не учитывается.

Complete

ПравилоСообщениеСрабатывает на
—Нет описания.Пустое описание.
—Нет имени.Пустое имя.
R9R9 - Формулировки открытых перечней: [...]including but not limited to, etc, and so on, and so forth, such as, among others.

Singular

ПравилоСообщениеСрабатывает на
R18R18 - Напишите одно предложение (найдено: N).Больше одного предложения (также японские и китайские предложения, заканчивающиеся на 。, ! или ?).
—Завершите утверждение точкой.Описание, которое не заканчивается на “.” (или 。).
R19R19 - Объединяет два требования; разделите на отдельные требования: [...]and, or, but, however или whereas, соединяющие два действия или две обязанности (“shall log and report each fault”, “… and the operator shall …”), “nor shall”, второе предложение после “;”; “and/or” перед вторым действием. См. Два требования в одном (R19).
R19R19 - “и/или” неоднозначно; укажите, имеются ли в виду оба или один: [and/or]“and/or” между значениями или в условии.
R19R19 - Объединяет два значения; разделите, если каждое проверяется отдельно: [...]and, or, соединяющие два объекта или значения после одного действия (“measure the temperature and the humidity”). Это примечание: Singular остаётся Yes.
R20R20 - Содержит обороты с целью; перенесите в Rationale: [...]purpose of, in order to, so that, for the purpose of, so as to.
R21R21 - Содержит скобки; перенесите текст в скобках в Rationale.“(” или “[” (а также полноширинные скобки).

Conforming

СообщениеСрабатывает на
Используйте модальный глагол: [need, shall, will, should, must]Ни одно из этих слов не встречается.

Appropriate

ПравилоСообщениеСрабатывает на
R31R31 - Навязывает решение: [...]using, by means of, utilizing, utilising, implemented in, implemented with, via a, via the, built with, written in.

Necessary

ПравилоСообщениеСрабатывает на
R30R30 - Очень похоже: [3.2 Battery Capacity (сходство 81,3%), ...]Другое требование в области, описание которого похоже не менее чем на 75 % (сходство по парам символов). Замечание называет до пяти и считает остальные (“and 3 more”). Прямой родитель и дочерние элементы требования (decomposed by, decomposes) не сравниваются: уточнение часто повторяет формулировку родителя. Соседние и несвязанные требования сравниваются.

Verifiable

СообщениеСрабатывает на
Свяжите Test Case или Requirement, который его верифицирует.У требования нет связи verified by с Requirement или Test Case.
AI: not verifiable as written — <причина>Принятое замечание ИИ из проверки требований с ИИ.

Feasible

ПравилоСообщениеСрабатывает на
R26R26 - Абсолютные термины, которые редко достижимы: [...]always, never, 100%, 100 percent, all the time, totally, completely, absolutely, zero defects, forever, continuous, continuously, uninterrupted.
—Нужно суждение рецензентаАбсолютных терминов и почти дубликатов не найдено; решать должен человек.

Correct

СообщениеСрабатывает на
Нужно суждение рецензентаВсе текстовые проверки (Appropriate, Complete, Conforming, Necessary, Singular, Unambiguous) пройдены; решать должен человек.

Поскольку Correct и Feasible заканчиваются на “Нужно суждение рецензента”, пока кто-нибудь не решит, наивысшая автоматическая оценка — 7 из 9 (78 %).

Два требования в одном (R19)

Требование утверждает что-то одно. R19 рассматривает каждое “and”, “or”, “nor”, “but”, “however”, “whereas”, “as well as” и “and/or” и относит его к одному из видов:

ВидПримерРезультат
Два требования“The unit shall log and report each fault.” “The pump shall stop, and the operator shall be alerted.” “… to acknowledge alarms and to silence the horn.” “…; it shall also …”Замечание. Singular — No.
Неоднозначное “and/or”“The log shall record the user ID and/or the badge number.”Замечание: укажите, имеются ли в виду оба или один. Singular — No.
Два значения“The station shall measure the temperature and the humidity.”Примечание: разделите, если каждое значение проверяется отдельно. Singular остаётся Yes; примечание показано серым и не снижает оценку.
Без замечаний“between 5 °C and 30 °C”; “When A and B, the unit shall …”; “… when the door is open and the fan is off”; “requirements 2.1 and 2.2”; текст в кавычках; “The command and control unit shall …”; “ASME Boiler and Pressure Vessel Code”; “5 Nm at 3000 rpm and 24 V”; “including batteries and strap”; “either open or closed”Ничего.

Два значения одной величины (“at -20 °C and 60 °C”) получают примечание. “, and” завершает условие: “… when the level falls below 10 %, and restart when …” — это замечание. Подлежащее, действующее как одно целое (“The Owner and the Contractor shall agree …”, “The power and data connector shall …”), примечания не получает; два подлежащих, каждое из которых действует (“The pump and the valve shall close …”), получают примечание. Сравнения (“12 or more”) не помечаются. Название после действия невозможно отличить от двух значений, поэтому внесите его в Составные имена.

Составные имена. На странице “Качество” Ещё ▾ → Составные имена… открывает список проекта с именами, которые содержат “and” или “or”, но называют одну вещь, по одному в строке (например, “power and data connector”). R19 их не помечает. Расшифровки из глоссария сокращений проекта (утверждения Acronym, см. Поиск сокращений) тоже учитываются, а несколько распространённых имён встроены (“command and control”, “research and development”, “operations and maintenance”, …). Список сохраняется с проектом, и его изменения можно отменить. Чтобы применить изменение, снова нажмите Проверить качество.

Требования на других языках

Holarch определяет язык каждого требования по его тексту. Правила по словам (R2–R10, R16, R19, R20, R24, R26, R31–R35, “up to”, модальный глагол, единицы) оценивают требования на английском.

Немецкий, французский и испанский (бета). Такие требования получают те же правила на своём языке, например “angemessen” или “bei Bedarf” на немецком, “approprié” или “si possible” на французском, “adecuado” или “según corresponda” на испанском. Пока правила для языка в бета-версии:

  • каждое замечание — предложение с пометкой (бета). Оно показывается серым вместе с другими примечаниями и никогда не снижает критерий или оценку;
  • показывается примечание “Правила формулировок для этого языка в бета-версии: только предложения, без оценки. Проверки структуры действуют.”, а Unambiguous имеет значение – (не проверено), пока формулировка не проверена с ИИ или не оценена вручную;
  • слова для “each” (jede, chaque, cada) — правильный выбор и не помечаются, как и “alle 5 s” или “tous les 5 s” (каждые 5 s).

Правило начинает учитываться для языка только после того, как оно измерено не менее чем на 300 утверждениях, написанных на этом языке, и проверено инженером по требованиям — носителем языка (не менее 90 % замечаний верны), и рецензент его одобрил. Когда это происходит, оценки для этого языка могут измениться при следующей проверке; об этом говорится в примечаниях к выпуску.

Другие языки (японский, итальянский, китайский и остальные) получают:

  • примечание “Правила формулировок охватывают английский. Проверки структуры действуют.” и – (не проверено) для Unambiguous: критерий не учитывается в оценке, пока формулировка не проверена или не оценена вручную. Другое замечание по Unambiguous, например TBD, по-прежнему делает его невыполненным;
  • проверки для любого языка: R18 (также 。), завершающая точка (также 。), R17, R21, TBD/TBR, R30, имя, описание и связь верификации.

Каждый язык, в бета-версии или нет, также получает эти проверки. Предложения хранятся на английском, а слова цитируются как написаны (“R7 - Imprecise wording: [angemessen] (beta)”), поэтому фильтр quality:R7 и экспорт работают одинаково на всех языках. Публичный API возвращает их с правилом, словами и режимом (findings).

Проверить формулировку с ИИ. ✦ ИИ ▾ → Проверить формулировку с ИИ… на странице “Качество” (или ✦ Ещё ИИ ▸ у одного требования) применяет те же правила через настроенный ИИ на собственном языке каждого требования. Предпросмотр перечисляет замечания и необязательную переформулировку на этом языке (не отмечена). Применить выбранные добавляет замечания как замечания ИИ и убирает примечание (бета-предложения остаются примечаниями) одним шагом отмены. Правка текста очищает их. Нужен тариф с ИИ.

Ручные переопределения

Переопределяйте критерий, если вы не согласны с автоматическим результатом или чтобы зафиксировать решение рецензента.

  • На странице “Качество”: щёлкайте ячейку критерия, чтобы переключать её: первый щелчок задаёт ручное Yes (✔), следующий — ручное No (✘), третий очищает ручное значение, и снова решает автоматическая проверка. Ручная ячейка показывает отметку ручного значения; её подсказка говорит “(задано вручную)” и что сделает следующий щелчок.
  • В инспекторе или представлении элемента: каждый критерий — список с Да и Нет. Критерий, заданный вручную, также предлагает Автоматически (проверить снова), что возвращает его к автоматическому результату. Значения, заданные вручную, показывают “вручную”.

Ручное значение сохраняется при повторной проверке. Ручное No без других сообщений показывает “Отмечено No вручную.”

Переопределения очищаются в двух случаях:

  • Меняется имя или описание требования. Переопределения остаются в истории, а отмена возвращает их.
  • Вы выбираете Ещё ▾ → Очистить ручные оценки. Это также очищает принятые замечания ИИ.

Устаревшие результаты

Если имя или описание требования меняется после проверки, его результаты помечаются как устаревшие:

  • Страница “Качество” показывает “Устарело — запустить снова” с подсказкой “Текст изменился после последней проверки. Проверьте качество снова.”
  • Столбец Оценка качества документа показывает тег Устарело со значком часов (наведите указатель, чтобы увидеть причину).
  • Инспектор показывает “Качество: устарело — запустите снова”.

Включите Повторно проверять автоматически при изменении текста, чтобы избежать устаревших результатов. Тогда Holarch сразу повторяет проверку правил для изменённого требования. Настройка хранится в этом браузере.

Проверка качества из документа

В документе выберите Проверить ▾ → Проверить качество. Если выбрано требование, пункт называется Проверить качество этого требования и проверяет его. Если требование не выбрано, проверяются все видимые требования документа.

Результаты открываются в диалоге Проверка качества — <имя> с плитками и таблицей. Его кнопки: Экспортировать CSV, Экспортировать XLSX, Открыть в «Качестве» и Закрыть.

Документ без требований показывает “В этом документе нет Requirement для проверки. Утверждения не оцениваются.”

Проверка требований с ИИ

Используйте проверку требований с ИИ для первого мнения по критериям, которые правило решить не может: Correct, Feasible и Necessary. Она также ищет формулировки, которые правила пропускают, по Unambiguous (например, “up to 72 hours”, где, похоже, имеется в виду минимум, или “accurately” без меры) и Verifiable (никакой тест, анализ, осмотр или демонстрация не может показать, что требование в такой формулировке выполнено). ИИ получает замечания правил и сообщает только о том, что они пропустили.

  1. Выберите ✦ ИИ ▾ → Проверить с ИИ (N требований)….

    Для одного требования выберите Проверить с ИИ (это требование)… в его меню ✦ ИИ ▾ или ✦ Ещё ИИ ▸ → ✦ Проверить с ИИ… в его контекстном меню.

    Claude рецензирует требования. Они отправляются группами по 20, вместе с до 300 другими требованиями для проверки дубликатов. На включённом ИИ проверка считается как один запрос на 100 требований (с округлением вверх); перед проверкой более 100 требований диалог сообщает, сколько запросов она использует, например “Эта проверка использует 3 из оставшихся в этом месяце включённых запросов ИИ (52) (1 запрос на 100 требований).” Проверка, которой нужно больше запросов, чем осталось, не запускается.

  2. Просмотрите каждое требование в диалоге.

    Строка вверху говорит, что изначально отмечено: “Отмеченные элементы применяются. Переформулировки изначально не отмечены, чтобы вы сначала их прочитали. Заблокированные, утверждённые и включённые в базовую линию требования изначально не отмечены.”

  3. Отметьте изменения и переформулировки, которые вы принимаете.

    Строка над кнопками подсчитывает, что сделает применение, например “Применяет 7 значений и 2 переформулировки к: 5 требований.” Если ничего не отмечено, она гласит “Ничего не выбрано.”, а Применить выбранные неактивна.

  4. Нажмите Применить выбранные.

    Отмеченные элементы применяются, и одно нажатие “Отменить” возвращает всё назад. Уведомление сообщает “Применено N изменений ИИ”.

Для каждого требования диалог показывает:

  • Вердикт Yes/No и причину для Correct, Feasible, Necessary, Unambiguous и Verifiable.
  • Под каждым вердиктом — флажок с подписью о том, что изменит его применение, или “без изменений” без флажка, если сохранённое значение уже совпадает:
    • Correct, Feasible и Necessary: “No → Yes” или “Yes → No”, если вердикт отличается от сохранённого значения, “Задать Yes” или “Задать No”, если значения нет.
    • Unambiguous и Verifiable: “Добавляет замечание”, где ИИ нашёл проблему, и “Снимает предыдущее замечание”, где прежнее замечание ИИ больше не актуально.
  • Необязательный комментарий.
  • Где ИИ её предлагает — флажок Применить переформулировку: с пословным сравнением.

Что изначально отмечено:

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

Если отметить переформулировку, флажки Unambiguous и Verifiable этого требования становятся неактивными с подписью “Повторно проверено после переформулировки”: проверки правил выполняются снова на новом тексте. Снятие отметки с переформулировки восстанавливает флажки как были. Correct, Feasible и Necessary по-прежнему применяются.

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

Что делает применение:

  • Correct, Feasible и Necessary становятся ручными значениями Yes/No.
  • No для Unambiguous или Verifiable становится замечанием ИИ: страница “Качество” перечисляет его вместе с замечаниями правил как “AI: ambiguous — <причина>” или “AI: not verifiable as written — <причина>”, а критерий показывает ✘. Yes убирает прежнее замечание ИИ.
  • Замечания ИИ очищаются, когда меняется имя или описание требования (в том числе принятой переформулировкой), и командой Ещё ▾ → Очистить ручные оценки.

Что делает Применить выбранные:

  • Вердикты становятся ручными значениями с сообщением “AI: <причина>”. Они сохраняются при повторной проверке.
  • Переформулировки заменяют описание и снова запускают проверку.

Экспорт качества

ЭкспортСодержимое
Экспорт ▾ → CSV (quality_report.csv)Одна строка на требование и критерий: Number, Name, Description, Quality Score, Attribute, Message, Result.
Экспорт ▾ → Excel (.xlsx) (quality_report.xlsx)Number, Name, Description, Rationale, Quality Score, Attribute, Message, Result, причём ячейки требования объединены по его девяти строкам, Yes выделено зелёным, No — красным, а в конце — Оценка для отчёта (доля ответов Yes среди всех ответов).
Поставка ▾ → Все экспорты… → Замечания по качеству (Excel) документаТа же структура для одного документа, со столбцами отображения документа.

Утверждения

Используйте Потребности и требования → Утверждения, чтобы увидеть всё, что ожидает решения. Страница открывает базу данных с запросом Requirement:"Status=In Review".

Здесь есть все функции базы данных:

  • Выберите несколько строк и используйте панель массовых действий, чтобы задать Status или метки сразу.
  • Экспортируйте список.
  • Дважды щёлкните строку, чтобы открыть представление элемента и полную историю.

Блок утверждений

Блок утверждений появляется в инспекторе и представлении элемента каждого требования. Он показывает:

  • Текущий статус цветным чипом (Draft, если статус не задан).
  • Последнее зафиксированное решение: “<статус> by <имя> · <дата и время>”, а затем “— <примечание>”, если оно есть (например, “— Текст изменён после утверждения”), или “Утверждение не зафиксировано”.
  • Кнопки, применимые к текущему статусу:
КнопкаКогда показываетсяДействие
УтвердитьStatus не Approved и не RejectedЗадаёт Approved и фиксирует вас и время. Уведомление: “Утверждено”.
Отклонить…Status не Approved и не RejectedЗапрашивает Причина (необязательно) в диалоге Отклонить требование, затем задаёт Rejected. Уведомление: “Отклонено”.
Открыть сноваStatus — Approved или RejectedЗадаёт In Review. Уведомление: “Перемещено в In Review”.

Записывается имя вашей учётной записи. Задание Status вручную в таблице или инспекторе также фиксирует решение с вашим именем и временем. Читатели видят блок без кнопок.

Когда рабочий процесс направляет переход в Approved через запрос на изменение, блок вместо этого показывает открытый запрос и его счётчик, например CR-4: 1 из 3 утверждений. После применения решение называет каждого утверждающего и запрос: “Approved by Ann Lead, Bob Discipline · <дата и время> · CR-4”.

Примечание: изменение имени или описания требования со статусом Approved переводит его в In Review с пометкой “Текст изменён после утверждения”. Уведомление сообщает “N утверждённых требований перемещено в In Review.” Изменение других атрибутов не открывает его снова.

Реестр TBD/TBR

Используйте реестр, чтобы отслеживать каждый открытый пункт до закрытия. Откройте Потребности и требования → TBD/TBR. Из документа выберите Проверить ▾ → Реестр TBD/TBR, чтобы открыть реестр с областью этого документа.

  • Заголовок страницы: Экспортировать XLSX (недоступно, когда реестр пуст).
  • Строка области: Область (Все требования или Документ: <имя>).
  • Плитки: Открытые TBD/TBR, Просрочено, Без владельца и чипы По документам (“<документ>: <число>”), открывающие каждый документ.
  • Открытые элементы во времени: диаграмма сгорания числа открытых пунктов. Она строится заново по истории требований — до 60 точек от самого старого требования до текущего момента. Наведите указатель на точку, чтобы увидеть её дату и число. Если истории слишком мало, показывается “Пока недостаточно истории для диаграммы сгорания.”
  • Столбцы Таблица:
    • Номер и Имя с описанием.
    • Документ.
    • Тип: TBD, TBR или TBS, с пометкой “атрибут”, “в тексте” или обеими.
    • Владелец: TBD Owner, иначе Owner требования, иначе “—”.
    • Срок: единый срок требования — та же дата, что и Срок в группе Рабочий процесс инспектора и в представлении элемента. Это атрибут TBD Due Date, если в нём есть дата, иначе срок требования. Под прошедшей датой показывается “Просрочено”. Просроченные строки выделены цветом.
    • Возраст: дней с момента открытия пункта.
    • Закрыть.

Щёлкните строку правой кнопкой или нажмите на ней Shift+F10, чтобы открыть то же меню строки, что и в базе данных: предлагаемые действия с причинами, ✦ Ещё ИИ ▸, Открыть, Переименовать…, Дублировать, Добавить дочерний…, Status ▸, Priority ▸, Связать с ▸, Добавить в документ ▸, Показать на диаграмме ▸, Копировать ссылку, Копировать номер и Удалить…. В других контекстных меню требование с открытым TBD или TBR начинается с Разрешить TBD…, что открывает этот реестр с выбранным требованием.

Реестр доступен только для чтения. Чтобы изменить срок, выберите строку и задайте Срок в инспекторе. Holarch задаёт срок требования и, если в атрибуте TBD Due Date есть дата, также этот атрибут (сохраняя время суток); одно нажатие “Отменить” возвращает всё назад. Очистка поля Срок очищает оба.

Закрыть появляется, только если задан атрибут TBD/TBR. Кнопка задаёт атрибуту значение None:

  • Если в тексте ничего не осталось, уведомление сообщает “Закрыто”.
  • Если в тексте ещё есть TBD, TBR или TBS, уведомление сообщает “Атрибут закрыт; текст всё ещё содержит TBD.”
  • У пункта, возникшего только из текста, нет кнопки “Закрыть”; чтобы закрыть его, исправьте текст.

Если ничего не открыто, страница показывает “Открытых элементов TBD/TBR нет. Чтобы элемент появился здесь, задайте атрибут TBD/TBR требования или напишите TBD, TBR или TBS в его тексте.”

Экспортировать XLSX записывает TBD-TBR Register.xlsx со столбцами Number, Name, Document, Type, Source (атрибут, текст или оба), Owner, Due Date, Opened, Age (days), Overdue (Yes красным) и Description.

Используйте Ссылки для проверки (в других инструментах — подозрительные связи), чтобы найти то, что нужно перепроверить после изменения требования. Связь требует проверки, если элемент на её другом конце изменился после последней проверки связи: убедитесь, что связь по-прежнему верна, затем отметьте её проверенной. Их перечисляет Потребности и требования → Ссылки для проверки. Из документа используйте Проверить ▾ → Ссылки для проверки.

Такие изменения требования помечают его связи для проверки:

  • Имя или Описание.
  • Priority, Criticality, Verification Method или Verification Level.
  • Любой числовой, процентный атрибут или атрибут длительности.

Затем Holarch помечает все связи требования таких типов: decomposed by, derived by, refined by, satisfied by, verified by и traced to.

Изменённый Verification Method или Verification Level помечает только связи verified by. Задание первого метода или уровня требования ничего не помечает: это планирует верификацию и не меняет ничего, что было проверено.

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

  • Страница Ссылки для проверки: по строке на каждую связь для проверки.
  • Документы и база данных: значок ⚠ Рецензировать в строке элемента (“Элемент на другом конце изменился после последней проверки этой связи. Убедитесь, что связь по-прежнему верна, затем отметьте её проверенной. Щёлкните, чтобы проверить.”).
  • Инспектор и представление элемента: баннер “⚠ Рецензировать: <требование> изменилось после последней проверки этой связи. Убедитесь, что связь по-прежнему верна, затем отметьте её проверенной.” Его кнопка Рецензировать… открывает для этого элемента диалог Ссылки для проверки — <элемент> с кнопками Открытые связи для рецензирования и Закрыть.
  • Раздел Трассировка инспектора: ⚠ рядом с каждой связью для проверки, с изменёнными полями и датой во всплывающей подсказке.
  • RVTM: ⚠ после требования со связью для проверки на любом конце (оно изменилось или изменился вышестоящий элемент); щёлкните его, чтобы проверить эти связи. ⚠ после тестового случая в Verified by помечает эту связь верификации.

Вверху страница объясняет правило и показывает таблицу:

СтолбецСодержимое
(флажок)Выбор для Отметить выбранные как проверенные…. Флажок в заголовке выбирает все.
ИзмененоТребование, которое изменилось.
ИзменениеИзменённые поля, например “Description” или “Priority, Verification Level”.
Когда / кемДата и время изменения и кто его внёс.
СвязьТип связи, читаемый от изменённого требования (например, “satisfied by”).
Элемент для проверкиЭлемент на другом конце связи.
(действия)Сравнение и Отметить как проверенное….

Щёлкните строку правой кнопкой или нажмите на ней Shift+F10, чтобы открыть меню строки элемента, как в базе данных: предлагаемые действия, ✦ Ещё ИИ ▸, Открыть, Переименовать…, Дублировать, Добавить дочерний…, Status ▸, Priority ▸, Связать с ▸, Добавить в документ ▸, Показать на диаграмме ▸, Копировать ссылку, Копировать номер и Удалить…. В других контекстных меню (база данных, документы) элемент со связью для проверки начинается с Проверить ссылку…, что открывает его проверку.

Сравнение открывает Изменение — <требование> с пословным сравнением имени и описания. Если изменились только атрибуты, там написано “Изменены только атрибуты: <поля>. Подробности — в истории элемента.” История… открывает историю требования.

Чтобы отметить связи проверенными:

  1. Нажмите Отметить как проверенное… в строке, Отметить выбранные как проверенные… для отмеченных строк или Отметить все как проверенные (N)….

    Откроется Отметить связи как проверенные (N): “Подтвердите, что связанные элементы остаются верными после изменения. К каждому связанному элементу добавляется комментарий.”

  2. Введите необязательный комментарий, например “Child still valid; no change needed.”
  3. Нажмите Отметить как проверенное.

    Уведомление сообщает “Отмечено как проверенные: N связей.”

Отметить выбранные как проверенные… без выбранных строк показывает “Сначала выберите связи, которые нужно отметить как проверенные.”

Отметка связи как проверенной записывает проверку в связь: кто, когда, комментарий и поля. Если вы написали комментарий, Holarch также добавляет “Link reviewed (<требование> changed: <поля>): <комментарий>” в комментарии каждого элемента. Отмена возвращает всё обратно.

Если связей для проверки нет, страница показывает “Нет связей для рецензирования. Связь требует рецензирования, когда элемент на её другом конце изменяется после последней проверки связи.”

Базовые линии и сравнение версий

Базовые линии документов

Создавайте и используйте базовые линии документа через Версия ▾ в штампе документа. Там перечислены:

  • Текущая версия: живой документ.
  • Каждая базовая линия этого документа, от новых к старым, с датой.
  • В разделе Базовые линии проекта — все базовые линии проекта.
  • Сохранить базовую линию… и Сравнить версии… (неактивно, пока у документа нет базовой линии: “Сначала сохраните базовую линию”).

Сохранить базовую линию… открывает Сохранить базовую линию:

  • Имя * (обязательно).
  • Утверждения: строки с именем, ролью и заявлением и кнопка + Добавить утверждающего. Первая строка заполнена вашим именем. Если пусто — “Нет утверждающих.”
  • Примечание “Базовая линия сохраняет эту версию документа (его элементы, их атрибуты и связи) для последующего просмотра, сравнения и восстановления. Записи об утверждении датируются текущим моментом и впоследствии не изменяются.”

Выберите базовую линию в Версия ▾, чтобы просмотреть её. Документ становится доступным только для чтения, с баннером “Базовая линия “<имя>”, только чтение, сохранено <дата>” и списком утверждений. Появляются такие кнопки:

КнопкаДействие
К текущей версииВозвращает к живому документу.
РедактированиеРедактировать базовую линию: переименовать её и добавить записи об утверждении. Утверждения (заблокировано) перечисляет существующие записи, которые нельзя изменить; новые записи “датируются текущим моментом и добавляются в список”. Только для базовых линий документа.
Сравнить с текущейОткрывает Сравнить версии от этой базовой линии. Только для базовых линий документа.
Восстановить базовую линиюБазовая линия документа: “Заменить сущности, порядок и структуру этого документа базовой линией “<имя>”? Сущности, добавленные с тех пор, убираются из документа (не удаляются). Действие можно отменить.” Базовая линия проекта: Заменить проект базовой линией, “Заменить весь проект базовой линией проекта “<имя>”? Действие можно отменить.”
Удалить“Удалить базовую линию “<имя>”?”

В живом документе каждая строка несёт полосу изменения: новая с момента базовой линии, изменённая с момента базовой линии или без изменений. Сравнение идёт с последней базовой линией документа или, если её нет, с последней базовой линией проекта.

Сравнение версий

Используйте отчёт об изменениях, чтобы точно увидеть, что изменилось после рецензирования.

  1. Нажмите Версия ▾ → Сравнить версии… или Сравнить с текущей в баннере базовой линии.

    Откроется Сравнить версии.

  2. Выберите От: базовую линию.
  3. Выберите До: более позднюю базовую линию или Текущая версия.

    Таблица перечисляет Номер, Имя, Изменить тип, Поле и Изменение (пословное сравнение для изменённого текста).

Типы изменений:

Тип измененияЗначение
Добавлено / УдаленоСущность вошла в документ или покинула его.
ИзмененоИзменилось поле: Name, Number, Description, Class, Image или любой атрибут (поле называется).
Метка добавлена / Метка удаленаМетка была добавлена или удалена.
Связь добавлена / Связь удаленаСвязь, касающаяся документа, была добавлена или удалена.
Атрибут связиИзменились атрибуты связи.

Изменения (Excel) записывает “<документ> (Changes).xlsx” со столбцами Number, Name, Class, Change Type, Field, Old Value и New Value. Исправления (Word) записывает то же сравнение в виде исправлений Word.

Поставка ▾ → Изменения (Excel)… документа (также в Все экспорты…) экспортирует тот же отчёт с полями От и До. Если базовой линии нет, он завершается сообщением “У этого документа нет базовой линии. Сначала сохраните её.”

Документ (Word) заполняет таблицы Revision History и Approvals вывода Word по базовым линиям документа.

Страница “Базовые линии и версии”

Используйте Контроль и рецензирование → Базовые линии и версии, чтобы управлять всеми базовыми линиями проекта. Базовые линии проекта содержат все сущности; базовые линии документа содержат один документ и создаются через Версия ▾ → Сохранить базовую линию… документа. В заголовке страницы есть Восстановить предыдущую версию…, что возвращает более раннее автоматическое сохранение всего проекта, и + Сохранить базовую линию….

Чтобы создать базовую линию проекта:

  1. Нажмите + Сохранить базовую линию… в заголовке страницы.

    Диалог Сохранить базовую линию проекта показывает текущее число сущностей и связей. Имя по умолчанию — “Baseline <n>”; подсказка в поле гласит “Имя, например “SRR””.

  2. Введите имя, затем нажмите Enter или Сохранить базовую линию. Пустое имя отклоняется (“Введите имя.”).

    Уведомление сообщает “Базовая линия сохранена”.

Карточки страницы:

  • Карточка Базовые линии: текущие числа (“Сейчас: элементы: <n>, связи: <n>”) и фильтр: Все базовые линии, Базовые линии всего проекта или Документ: <имя>. Столбцы:
    • Имя.
    • Документ: ссылка для просмотра документа на момент этой базовой линии или “Project”.
    • Создано.
    • Утверждения: “✔” и имена утверждающих. Наведите на них указатель, чтобы увидеть роль, дату и заявление. “by <имя>” называет создателя.
    • Сущности и Связи.
    • Сравнить: задаёт эту базовую линию как “От”, а текущую рабочую копию — как “До”.
    • ⋯ (другие действия):
      • Переименовать…: Переименовать базовую линию.
      • Экспорт (JSON): скачивает “<имя>.json” (формат holarch-baseline, со снимком и утверждениями).
      • Восстановить базовую линию… (базовая линия проекта): “Заменить все текущие сущности и связи базовой линией “<имя>”? Действие можно отменить (⌘Z / Ctrl+Z).” Уведомление: “Восстановлено: “<имя>””.
      • Вернуть документ… (базовая линия документа): “Восстановить документ “<док>” до базовой линии “<имя>”? Изменятся только сущности и структура этого документа. Действие можно отменить.” Недоступно, если документ удалён.
      • Удалить…. В размещённом сервисе переименовывать и удалять базовую линию могут только владельцы проекта; для остальных эти пункты неактивны с указанием причины.
  • Потерянные базовые линии (показывается при необходимости): “N базовых линий удалённых документов”. У каждой есть Восстановить документ, что заново создаёт артефакт документа и его сущности из базовой линии, и Удалить.
  • Карточка Сравнить: выберите От (старая) и До (новая). “До” — это Текущая версия или другая базовая линия той же области.
    • Плитки: Добавлено сущностей, Удалено сущностей, Изменено сущностей, Изменения связей.
    • Таблица показывает Сущность, Изменение, Поле и Различие (пословное сравнение). Атрибуты дат показываются в формате дат приложения.
    • Экспортировать CSV и Экспортировать XLSX записывают “Changes <from> to <to>”.
    • Если показывать нечего: “Между “<from>” и “<to>” нет различий.”

Если базовых линий нет: “Нет базовых линий. Создайте её, чтобы зафиксировать текущее состояние проекта.”

Примечание: базовые линии хранятся в проекте и переносятся вместе с ним при экспорте проекта. Базовая линия проекта содержит сущности и связи. Базовая линия документа также содержит настройки структуры документа.

Импорт требований

Используйте Потребности и требования → Импорт и экспорт, чтобы загрузить требования из файлов. Импорт проходит четыре шага: Файл → Сопоставление → Проверка → Импорт.

  • Назад и Продолжить переключают шаги. Импортировать N элементов на шаге проверки выполняет импорт, и одно нажатие “Отменить” возвращает всё назад.
  • Одна зона перетаскивания принимает все форматы. Формат определяется по файлу (по имени, а если этого недостаточно — по содержимому) и показывается в поле Формат, где его можно изменить.

Форматы: Word (.docx), файлы проектов Holarch (.holarch, .json), Excel / CSV (.xlsx, .csv), Простой текст (.txt), UML/SysML (.xmi, .uml, .mdzip) и ReqIF (.reqif).

В этом разделе описаны форматы требований. О файлах проектов, XMI и всех других видах импорта и экспорта см. Импорт и экспорт.

Шаг 1: файл

Перетащите файл в поле “Перетащите файл сюда или щёлкните, чтобы выбрать его” или вставьте текст в поле и нажмите Анализировать текст (CSV со строкой заголовка, ReqIF XML, XMI, JSON или текст документа).

ПараметрЗначенияДействие
ФорматШесть форматов вышеПоказывает распознанный формат. Выберите другой, чтобы прочитать то же содержимое иначе.
Кодировка текста (CSV, текст)Автоматически, UTF-8, ISO-8859-1 / Windows-1252, Shift_JIS, Big5, UTF-16Как читаются байты файла. Изменение перечитывает файл.
Лист (книги)“<имя> (N строк)”Лист для импорта. Заранее выбран первый лист с данными.
  • Простой текст: поле сохраняет импортированное содержимое доступным для правки. Измените его и нажмите Повторить анализ.
  • Строка состояния сообщает “Проанализирован “<файл>”: N строк, M столбцов.” (плюс “(лист “<имя>”)” и, для Word, “, таблиц: N”).

Шаг 2: сопоставление

Каждый столбец файла — одна строка: Столбец файла (заголовок и позиция), Примеры значений (первые три строки) и Поле Holarch. Выберите Пропустить, чтобы не импортировать столбец. Поля, сопоставленные по заголовку столбца, отмечены как авто.

Поле HolarchСодержимое
Имя, Номер, ОписаниеСобственные поля элемента.
Класс, МеткиИмя класса; имена меток через ; , или |.
Номер родителя, Глобальный IDНомер родителя; ID, по которому сопоставляются существующие сущности.
АтрибутЛюбой атрибут класса для строк без класса.
СвязьНесколько целей разделяйте через ;.
ID строки, ID родительской строки, Новый атрибут (добавлен в схему)Структура из файлов ReqIF и XMI, а также новые атрибуты.

✦ ИИ ▾ → Предложить сопоставление предлагает поле для каждого столбца. Предложенное сопоставление перечисляет изменения, отмеченные, с причиной от ИИ; Применить отмеченные меняет сопоставление. Пока ничего не импортируется.

Holarch угадывает сопоставление по заголовку:

ЗаголовокСопоставляется с
Number, No, Num, #, ID Number, Req Number, Requirement NumberНомер
Name, Title, Short Name, Requirement NameИмя
Description, Text, Requirement, Requirement Text, Statement, DescОписание
Class, Type, Entity ClassКласс
Labels, Label, TagsМетки (значения через ; , или |)
Parent, Parent NumberНомер родителя
Global ID, ID, GUID, UUIDГлобальный ID
Имя атрибута (например, Priority, Rationale, Status)Этот атрибут. “Method” и “Verification” сопоставляются с Verification Method.
Имя группы меток (например, Verification Method, если такого атрибута нет)Метки
Имя связи (например, satisfied by)Эта связь; несколько целей разделяйте через ;
Object Identifier, Origin IDГлобальный ID
Object Number, ReqIF.ChapterName, ReqIF.ForeignIDНомер
Object Heading, ReqIF.Name, Long NameИмя
Object Text, ReqIF.Text, ReqIF.DescriptionОписание
ReqIF.CategoryКласс
ReqIF ID, XMI ID, Row ID / Parent IDID строки / ID родительской строки

Новый атрибут создаёт атрибут с именем столбца в каждом импортируемом классе. Его тип определяется по значениям:

  • Число, если каждое значение — число.
  • Список вариантов, если различных коротких значений немного.
  • Длинный текст — для значений длиннее 120 символов.
  • Иначе — текст.

Критерии качества, вычисляемые и файловые атрибуты сопоставить нельзя.

Под столбцами:

ПараметрЗначенияДействие
Класс для строк без классаЛюбой класс; по умолчанию RequirementКласс строк без значения в столбце Class и без подходящего правила класса.
Правила классовОписание содержит слово или фразу → класс+ Правило добавляет правило, × удаляет его. Первое подходящее правило применяется к строкам без значения Class.
Сопоставлять существующие сущности поГлобальный ID, имя, номерСтроки, совпадающие с существующей сущностью, обновляют её, а не создают копию. Для совпадений по имени и номеру также нужен тот же класс.
Сопоставлять связанные сущности поГлобальный ID, имя, номерКак значения в столбцах связей находят свои цели.
Формат даты в столбцах дат (CSV)Автоматически, yyyy-MM-dd HH:mm:ss, dd/MM/yyyy, MM/dd/yyyy, yyyyMMdd, Другой…Как читаются ячейки с датами. Другой… показывает поле для собственного шаблона (например, dd.MM.yyyy HH:mm) с yyyy, MM, dd, HH, mm и ss.
Шаблон нумерации (Word, текст)Пусто (автоматически) или маркеры, например 1. a) (i), или иерархические номера, например 1.1 или 1.1.aКак нумерованные абзацы становятся структурой. Для текста шаблон определяется по нумерации и заполняется автоматически. Стилям заголовков Word и нумерации списков шаблон не нужен. См. Шаблон нумерации.
Нумеровать дочерние элементы под родителем (1 → 1.1) (Word, текст)Включено по умолчаниюСозданные номера дочерних элементов становятся “3.1”, “3.2” вместо “1”, “2”.

Иерархия. Номера структуры восстанавливают иерархию: “1.2.3” становится дочерним для “1.2”. Столбец Номер родителя или пара ID строки и ID родительской строки задают родителя явно. Элементы без родителя становятся элементами верхнего уровня документа.

Таблицы Word. Для файла Word раздел Таблицы Word перечисляет каждую таблицу. Таблицы, повторяющиеся с тем же заголовком в разных разделах, используют одно сопоставление. Раздел поясняет: “Импортируйте таблицу требований как сущности, по одной на строку, и сопоставьте её столбцы. Остальные таблицы остаются таблицами в описании элемента, за которым они следуют.”

  • Задайте для каждой таблицы Сущности (по одной на строку) или Таблица в описании.
  • Сопоставьте её столбцы с Number, Name, Description, Class, Labels, атрибутом, новым атрибутом или пропуском.
  • Заголовки вроде ID, Req ID, Requirement ID, Ref или Paragraph сопоставляются с Number.
  • Shall, Shall Statement, Requirement Statement, Requirement Text, Statement или Text сопоставляются с Description.

Таблица со столбцом номера или описания и строками с “shall” изначально импортируется как сущности.

Найденные на данный момент предупреждения появляются под столбцами, или “Предупреждений нет.”

Шаг 3: проверка

Проверьте результат, прежде чем что-либо изменится. Шаг проверки показывает изменения так же, как “Базовые линии и версии” сравнивает версии (см. Базовые линии и сравнение версий):

  • Первая строка называет файл, формат и число элементов по классам.
  • Создать документ требований из этих N требований появляется (отмеченным), когда каждый элемент — Statement или Requirement (или подкласс). Для других файлов там написано Создать документ из этих N элементов, без отметки. Если отмечено, выберите Тип документа (по умолчанию Requirements Document), Имя (по умолчанию — имя файла) и нужно ли Перенумеровать весь документ после импорта.
  • Далее идут предупреждения.
  • Плитки считают Новые элементы, Обновлённые элементы, элементы Сопоставлено, без изменений и Связи из файла.
  • Таблица изменений перечисляет каждый новый элемент с описанием и каждое изменённое поле обновлённого элемента с пословным сравнением старого и нового значения (первые 500 изменений).

Нажмите Импортировать N элементов. Уведомление сообщает “Импортировано: N новых, M обновлённых”.

  • Если предупреждений нет, Holarch открывает новый документ требований (или базу данных).
  • Иначе карточка Импорт завершён перечисляет предупреждения (“Импорт не выдал предупреждений.”, если всё чисто). Её кнопки: Открыть документ, Открыть базу данных, Диаграмма Spider, Древовидная диаграмма, Проверить качество и Начать другой импорт.

Описание нового документа перечисляет предупреждения импорта.

Как читается каждый формат

Word (.docx):

  • Заголовки и нумерация списков Word становятся структурой и сохраняют свои номера.
  • Заголовок становится Statement. Основной текст под ним становится его описанием.
  • Абзац с shall, must, will или should становится дочерним Requirement с именем из слов после модального глагола. Нумерованный пункт списка тоже; без модального глагола он становится Statement.
  • Маркированные пункты, изображения и таблицы входят в описание элемента, за которым они следуют, с сохранением полужирного, курсива, списков и таблиц.
  • Исходный файл .docx прикрепляется к новому документу, если он укладывается в предел вложения на файл.
  • Изображения PNG, JPEG, GIF, WebP и SVG сохраняются. Другие форматы изображений пропускаются с предупреждением.

Excel (.xlsx, .xlsm) и CSV:

  • Одна строка на сущность, любые столбцы. Первая строка — заголовок.
  • Многострочные ячейки сохраняют переносы строк.
  • Файлы Excel 97-2003 (.xls) не читаются. Сначала сохраните их как .xlsx или .csv.

ReqIF (.reqif, .reqifz):

  • Каждый SPEC-OBJECT становится строкой с ReqIF ID, Parent ID (из иерархии спецификации), Type (тип объекта, сопоставляется с Class), Long Name и по столбцу на каждое определение атрибута.
  • Столбцы без совпадения по умолчанию получают Новый атрибут. Атрибуты XHTML становятся атрибутами с форматированным текстом, а атрибуты-перечисления — списками вариантов.
  • SPEC-RELATION становятся связями по имени. Если имя не совпадает со связью, разрешённой схемой, они становятся traced to.
  • Архив .reqifz распаковывается автоматически.

Простой текст (.txt) или вставленный текст:

  • Нумерованная строка (“3.1 Battery”) или короткая строка без точки становится заголовком (Statement).
  • Каждое предложение с shall, must, will или should становится Requirement под текущим заголовком.
  • Остальной текст добавляется к описанию предыдущего элемента.
  • При заданном шаблоне нумерации (определённом по тексту или введённом) уровни определяет шаблон.

Обновление требований из электронной таблицы

Используйте этот способ, чтобы изменить много требований сразу в электронной таблице.

  1. В базе данных (или на странице “Требования”) нажмите Экспорт… и выберите Таблица (CSV).
  2. Отметьте атрибуты для правки. В разделе Включить отметьте ID, затем нажмите Экспорт.
  3. Измените значения в электронной таблице. Не меняйте столбец ID.
  4. Импортируйте файл. На шаге Сопоставление проверьте, что столбец ID сопоставлен с Глобальный ID, и задайте Сопоставлять существующие сущности по = Глобальный ID.
  5. На шаге Проверка снимите флажок Создать документ….

    Совпавшие строки считаются как Обновлённые элементы, с перечислением каждого изменённого поля.

  6. Нажмите Импортировать N элементов.

Значение I_… из файла, экспортированного до этого выпуска, не совпадает; используйте столбец ID. Все шаги и параметры описаны в разделе Импорт и экспорт.

Что записывает обновление:

  • Только сопоставленные столбцы. Если столбца Description нет, каждое существующее описание сохраняется.
  • Метки из файла добавляются к существующим меткам.
  • Без столбца Class строка, сопоставленная по глобальному ID, сохраняет класс своей сущности.

Сообщения импорта

СообщениеЗначение и исправление
Ни один столбец не сопоставлен с Name или Number. Сопоставьте один из них.Сопоставьте хотя бы один столбец с Name или Number.
Строка N: неизвестный класс “X”, используется <класс>.Значение Class не совпадает ни с одним классом. Исправьте значение или сопоставьте столбец с “Пропустить”.
Строка N: неизвестная метка “X” пропущена.Сначала создайте метку в схеме или исправьте значение.
Строка N: “<атрибут>” не относится к классу <класс>.У класса строки нет такого атрибута.
Строка N: “<значение>” не является допустимым значением типа <тип> для “<атрибут>”.Значение нельзя прочитать как число, дату, вариант и т. д. Проверьте параметр формата даты.
Строка N: имя длиннее 255 символов и было сокращено. / Строка N: номер длиннее 255 символов и был сокращён.Имена и номера ограничены 255 символами.
Повторяющийся номер X (строки A и B).У двух строк один номер; иерархия может прикрепить дочерние элементы к первой.
Строка N: нет номера родителя P для X; прикреплено к Q. / …; импортировано на верхний уровень.Номера прямого родителя нет в файле.
Строка N: номер родителя P не найден. / Строка N: родитель P не найден.Parent Number или Parent Row ID ссылается на строку, которой нет в файле.
Строка N: цель “X” связи “<связь>” не найдена.Столбец связи называет несуществующую сущность. Проверьте Сопоставлять связанные сущности по.
Строка N: связь “<связь>” от A к B не разрешена схемой (всё равно создана).Связь создана, хотя схема её не перечисляет.
Связь “X” между A и B не разрешена схемой; пропущена.Отношение ReqIF или XMI не удалось создать даже как traced to.
Изображение X: изображения .ext не поддерживаются и были пропущены. Чтобы сохранить изображение, сохраните его в Word как PNG или JPEG.Изображение Word в неподдерживаемом формате.
Изображение X (размер) превышает предел вложений <предел> и было пропущено.Изображение больше предела на файл.
Строки данных не найдены.В файле или листе есть только заголовок, или он пуст.
Не удалось прочитать файл: файлы Excel 97-2003 (.xls) не поддерживаются. Сохраните файл в Excel как .xlsx или .csv, затем импортируйте его сноваПреобразуйте файл.
Не удалось прочитать файл: XML с объявлением DOCTYPE или ENTITY не принимается. Сохраните файл без него и импортируйте сноваУдалите объявление из файла ReqIF или XML.
Не удалось прочитать файл: некорректный XMLФайл ReqIF не является корректно сформированным XML.
Импорт не удался: <причина>Импорт остановлен; ничего не изменено.

Сочетания клавиш для требований

КлавишиГдеДействие
EnterБыстрый ввод в документеДобавить введённое требование.
⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+EnterДокумент, элемент выбранДобавить соседний / дочерний элемент.
Enter или SpaceСтроки “Качество”, “TBD/TBR” и “Ссылки для проверки”Показать требование строки или элемент для проверки в инспекторе.
↑ / ↓Те же строки, строка в фокусеПерейти к предыдущей или следующей строке.
Щелчок с ⌘ / Ctrl, щелчок с ⇧ / Shift, щелчок с ⌘ / Ctrl+⇧ / ShiftСтроки “Качество”, “TBD/TBR” и “Ссылки для проверки”; строки базы данных; элементы документаПереключить строку, выбрать диапазон от последней щёлкнутой строки, добавить этот диапазон.
⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓Те же строки, строка в фокусеВыбрать все показанные строки; расширить выделение от строки в фокусе.
Правый щелчок, Shift+F10 или клавиша менюСтроки “Требования”, “Качество”, “TBD/TBR” и “Ссылки для проверки”; элементы документа и записи структурыОткрыть меню строки: сначала предлагаемые действия с причинами и ✦ Ещё ИИ ▸, затем команды элемента.
Esc“Качество”, “TBD/TBR”, “Ссылки для проверки”, RVTMСнять выбор строки.
EnterПоле имени в “Базовые линии и версии”Создать базовую линию проекта.
⌘Z / Ctrl+ZВездеОтменить последнее изменение, включая весь импорт, отметку связей как проверенных или смену статуса.

Все сочетания клавиш приложения см. в разделе Сочетания клавиш.

Настройки

НастройкаГдеПо умолчаниюОбласть
Повторно проверять автоматически при изменении текстаСтрока области на странице “Качество”Выкл.Этот браузер
Группы инспектора свёрнуты или раскрыты (Качество и остальные)Щёлкните заголовок группы в инспекторе или Свернуть все / Развернуть все в конце её ссылок“Качество” свёрнута, остальные раскрытыЭтот браузер, для каждого класса
Ваше имя в утверждениях, решениях и комментарияхИмя вашей учётной записи—Учётная запись
Статус прослеживания (точки у требований)Вид ▾ документаНа чёмДокумент

Сообщения

СообщениеГдеЗначение
Проверено N требованийКачествоПроверка выполнена для области.
В этой области нет требований.КачествоВ области нет требований.
В этом документе нет Requirement для проверки. Утверждения не оцениваются.Проверка качества документаСмените класс элементов на Requirement или проверьте другой документ.
Устарело — запустить снова / Устарело / Качество: устарело — запустите снова“Качество”, документы, инспекторТекст изменился после последней проверки.
Нужно суждение рецензента“Качество” (Correct, Feasible)Решать должен человек; щёлкните ✘, чтобы отметить Yes.
Отмечено No вручную.КачествоРецензент задал критерию значение No.
N утверждённых требований перемещено в In Review; N связей отмечено для рецензирования.После правкиПравка снова открыла утверждения и пометила связи для проверки.
Утверждено / Отклонено / Перемещено в In ReviewБлок утвержденийРешение зафиксировано.
Отмечено как проверенные: N связей.Ссылки для проверкиПроверки зафиксированы.
Сначала выберите связи, которые нужно отметить как проверенные.Ссылки для проверкиОтметьте строки, прежде чем нажать Отметить выбранные как проверенные….
Закрыто / Атрибут закрыт; текст всё ещё содержит TBD.TBD/TBRАтрибуту задано значение None.
Текст всё ещё содержит TBD. Исправьте текст, чтобы закрыть пункт.TBD/TBRПоказывается при закрытии пункта, возникшего только из текста.
Базовая линия сохраненаДокументы, “Базовые линии и версии”Снимок сохранён.
У этого документа нет базовой линии. Сначала сохраните её.“Сравнить с текущей”, отчёты об измененияхУ документа нет базовой линии.
Возвращено к “<имя>” / Восстановлено: “<имя>”Базовые линииДокумент или проект откатан; доступна отмена.
Нет требований для проверки. Сначала выберите или откройте требования.Проверка требований с ИИВ области нет требований.

Ограничения

  • Проверка качества: каждое требование области сравнивается с остальными на дубликаты (порог сходства 75 %).
  • Проверка требований с ИИ: 20 требований на запрос ИИ, с до 300 другими требованиями в качестве контекста.
  • Сравнение при проверке связей хранит первые 500 символов старого имени и 4000 символов старого описания.
  • Диаграмма сгорания TBD/TBR: до 60 точек.
  • Импорт:
    • Имена и номера до 255 символов.
    • Предпросмотр показывает первые 500 строк. Перечисляются первые 50 предупреждений (“…и ещё N”).
    • Шаблон нумерации имеет не больше 6 уровней (“В шаблоне нумерации больше 6 уровней. Используйте не больше 6 маркеров.”).
    • Файлы ReqIF/XML до 100 миллионов символов и 3 000 000 элементов.
    • Архивы .reqifz и .docx до 10 000 записей, 300 МБ на запись и 600 МБ в сумме.
    • Изображения и исходный файл Word сохраняются только в пределах лимита вложения на файл (10 МБ на тарифе Free, 25 МБ на Individual, 100 МБ на Team).