Требования
Генерация документов
Вставка живых матриц прослеживаемости, верификации и интерфейсов и отчётов об испытаниях в документы, экспорт в четырёх форматах, построение по базовой линии и проставление грифов: уведомление компании, заявление о распространении DoD, уведомление об экспортном контроле, авторское право или номер контракта на каждой странице и в каждом экспорте.
На этой странице
Обзор
Holarch строит поставляемые документы из модели, поэтому документ всегда соответствует требованиям, тестам и связям, стоящим за ним. Три инструмента покрывают то, что обычно запрашивают рецензенты:
- Блоки матриц: матрица прослеживаемости, верификации или интерфейсов либо отчёт об испытаниях внутри текста документа, которые обновляются при каждом изменении модели.
- Экспортировать матрицу: те же матрицы и отчёт об испытаниях в виде отдельного файла Excel, Word, CSV или веб-страницы, из текущей модели или из базовой линии.
- Грифы и параметры страницы: гриф организации, проекта или одного документа (уведомление компании, заявление о распространении, уведомление об экспортном контроле, авторское право или номер контракта) на каждом экспорте, а также титульная страница и номера страниц для Word.
Динамические значения и таблицы в тексте описаны на странице Документы: Динамическое значение… вставляет один атрибут сущности, Количество или сумма… — число, вычисленное по запросу, Динамическая таблица… — таблицу по запросу, а Перекрёстная ссылка… — текущий номер раздела, рисунка или таблицы.
Понятия
Матрицы
| Матрица | Строки | Столбцы | Выделяется как пробел |
|---|---|---|---|
| RTM (матрица прослеживаемости требований) | Требования | Номер, требование, родитель, Traced From, Traced To, Satisfied By | Требование без родителя и без источника трассировки |
| Матрица нисходящей декомпозиции требований | Требования | Номер, требование, Flows Down From, Flows Down To, производные требования | Требование верхнего уровня без дочернего и без производного требования |
| Матрица распределения требований | Требования | Номер, требование, компоненты, функции, прочее | Требование, которое ничто не удовлетворяет |
| Матрица соответствия (показывается, когда включена формальная программа) | Требования спецификации заказчика | Номер, требование, соответствие, ответ, наши требования и проект, верификация, отклонение/разрешение на отступление | Требование без заявления о соответствии (Не оценено) |
| RVTM (матрица прослеживаемости верификации требований) | Требования | Номер, требование, метод, уровень, Verified By, статус | Нет метода верификации или верифицирующего тестового случая |
| VCRM (матрица перекрёстных ссылок верификации) | Требования | Номер, требование, Inspection, Analysis, Demonstration, Test, Verified By, статус | Не выбран метод верификации |
| VCRM по уровням верификации | Требования | Номер, требование, затем I, A, D и T под каждым уровнем верификации, Verified By, статус | Нет метода верификации или уровня верификации |
| Отчёт об испытаниях | Тестовые случаи цикла тестирования | Номер, Test Case, Verifies, статус, фактический результат, прогон | Тестовый случай, не прошедший в цикле |
| Матрица распределения | Функции (Action) | Номер, функция, Performed By | Функция, которую не выполняет ни один компонент |
| Матрица интерфейсов | Компоненты (Asset) | Те же компоненты; ячейка перечисляет Conduit от компонента строки к компоненту столбца | Компонент без Conduit к другим компонентам или от них |
| Матрица N² | Функции (Action) | Те же функции; ячейка перечисляет Input/Output, которые генерирует функция строки и получает функция столбца | Функция, которая не обменивается ни входами, ни выходами |
| Пользовательская матрица | Сущности из поискового запроса | Сущности из второго запроса; ячейка называет связи между ними или показывает X для одной выбранной связи | Строка без связи ни с одним столбцом |
- Родитель — требование, которое строка декомпозирует. Traced From, Traced To и Satisfied By перечисляют связанные сущности. В матрице нисходящей декомпозиции Derived Requirements — это требования, к которым строка трассируется.
- В VCRM X отмечает каждый запланированный метод; Статус — результат верификации на данный момент, сведённый из тестовых случаев, как в Центре тестирования.
- В VCRM по уровням верификации столбцы сгруппированы по уровням атрибута Уровень верификации (Component, Subsystem, System). X стоит под уровнем требования и под каждым из его запланированных методов.
- Тестовые случаи никогда не перечисляются как функции: матрицы распределения и N² показывают Action, которые не являются Test Case.
- Область: матрица охватывает сущности одного документа (в порядке и нумерации документа), все части сборника или весь проект. Матрица распределения использует функции документа или все функции, если в документе их нет. Матрицы интерфейсов и N² могут также охватывать дочерние элементы одного Asset или Action, как диаграммы I² и N²; для всего проекта они перечисляют компоненты или функции, у которых есть Conduit или Input/Output, до 120. Пользовательская матрица показывает до 2000 строк и 120 столбцов.
- Блок Отчёт об испытаниях показывает один цикл тестирования одного набора тестов или его текущие результаты. См. Отчёты об испытаниях.
Динамические, а не скопированные
Блок матрицы хранит только то, что показывать, а не строки. Каждый раз при показе или экспорте документа Holarch заново строит строки из модели. Результат кешируется до следующего изменения, поэтому большие проекты остаются быстрыми.
Как использовать
Вставка матрицы в документ
- Откройте документ и щёлкните в описании документа или элемента.
- На панели инструментов форматированного текста откройте + и выберите Матрица….
- Выберите Матрица и Область. Изначально область — открытый документ.
- Для Пользовательская матрица введите поисковые запросы Строки и Столбцы (например,
class:Requirementиclass:Asset), выберите Связь или оставьте Любая связь и при желании задайте Заголовок. - Для Отчёт об испытаниях выберите Набор тестов и Цикл тестирования или Текущие результаты.
Показывается предпросмотр. Он обновляется при каждом изменении модели.
- Для Пользовательская матрица введите поисковые запросы Строки и Столбцы (например,
- Нажмите Вставить.
Матрица появляется в тексте с пунктирной рамкой. Её подпись называет матрицу, область и число строк с пробелами.
Матрицу нельзя редактировать по ячейкам; вместо этого измените модель. Чтобы убрать её, удалите таблицу в редакторе, как любое другое содержимое.
Экспорт матрицы
- В документе откройте Поставка ▾ и выберите Матрица прослеживаемости…. Или выберите Поставка ▾ → Все экспорты… и укажите Матрица прослеживаемости (Excel), (Word), (CSV) или (HTML).
- В Экспортировать матрицу выберите Матрица и Область, а в Экспортировать как — Матрица (Excel), Матрица (Word), Матрица (CSV) или Матрица (HTML).
- Необязательно: в Модель выберите базовую линию вместо Текущая модель. Список показывает базовые линии проекта и выбранного документа.
Строка под полями сообщает число строк и число строк с пробелами.
- Нажмите Экспорт.
Уведомление сообщает “Матрица экспортирована.” Пробелы закрашиваются красным в Excel, Word и на веб-странице. Экспорт в Word и на веб-страницу использует параметры страницы документа. В Word текстовые столбцы широкие, а столбцы методов верификации узкие, с заголовками К, A, Э и T и легендой под таблицей (I = Inspection, A = Analysis, D = Demonstration, T = Test). Матрицы с более чем пятью столбцами используют альбомную страницу. VCRM по уровням имеет вторую строку заголовка с уровнями; матрицы интерфейсов, N² и пользовательские закрашивают заголовки строк и диагональ.
Матрицы из базовой линии
Подписанный поставляемый документ должен показывать модель такой, какой она была в базовой линии, а не какая она сегодня. Матрица, построенная из базовой линии, использует сущности и связи базовой линии, а её заголовок заканчивается на “(базовая линия имя)”.
- Экспортировать матрицу: выберите базовую линию в Модель.
- Базовая линия проекта содержит всю модель, поэтому любая матрица работает из неё.
- Базовая линия документа содержит документ, его элементы и связанные с ними сущности. Матрицы этого документа полны. Матрица, выходящая за пределы документа (весь проект или матрица интерфейсов или N²), несёт примечание “Построено из базовой линии документа, которая содержит только этот документ и связанные с ним сущности.”
Отчёты об испытаниях
Отчёт об испытаниях даёт результаты одного цикла тестирования: что тестировалось, в какой конфигурации, что прошло и что не прошло и какие требования это верифицирует.
- В Центре тестирования зарегистрируйте цикл тестирования через Начать новый цикл…. Введите Конфигурация / сборка и Объект испытаний (оба поля начинаются со значений, чаще всего записанных в прогоне).
- На карточке набора откройте ⋯ и выберите Отчёт об испытаниях…. Или откройте ⋯ → Циклы тестирования… и нажмите Отчёт… у цикла.
- В Экспортировать отчёт о тестировании выберите Цикл тестирования, а в Экспортировать как — Отчёт об испытаниях (Word), (Excel), (CSV) или (HTML), затем нажмите Экспорт.
Отчёт Word (по умолчанию) содержит такие разделы:
- Идентификация: набор тестов, цикл тестирования, когда были сохранены результаты и когда составлен отчёт.
- Испытательная среда и конфигурация: конфигурация или сборка, объект испытаний, испытатели и даты прогонов.
- Сводка результатов: количества по статусам и доля успешных.
- Результаты по тестовым случаям: одна строка на тестовый случай.
- Подробные результаты: для каждого тестового случая ожидаемый и фактический результат, испытатель, дата, конфигурация, объект испытаний, файл подтверждения и результаты шагов.
- Отклонения и открытые проблемы: не прошедшие и заблокированные тестовые случаи со связанными Issue.
- Подтверждения испытаний: файлы подтверждений, записанные в цикле.
- Статус верификации требований: требования, которые верифицирует набор, со статусом по результатам этого цикла.
Excel даёт три листа (Results, Steps, Requirements); CSV и веб-страница дают таблицу результатов. Результаты берутся из цикла в сохранённом виде, поэтому отчёт не меняется после сброса набора. Имена, верифицированные требования и Issue берутся из текущей модели. Циклы, сохранённые до того, как начали сохраняться результаты шагов и подтверждения, показывают эти поля как “—”.
Чтобы поместить таблицу результатов в документ, вставьте блок матрицы Отчёт об испытаниях (см. выше).
Грифы документов и экспорта
Гриф — это текст, который Holarch печатает на всём, что вы экспортируете: верхний колонтитул вверху каждой страницы, нижний колонтитул внизу каждой страницы и уведомление на первой странице. Задайте его один раз для проекта или организации, и каждый экспорт будет его нести. Документ может заменить его собственным.
Примечание: облачный сервис (app.holarch.app) не может хранить CUI, секретную информацию или информацию под экспортным контролем (Условия использования). Поэтому стандартный список там не содержит Distribution Statement B–F и уведомление об экспортном контроле, а гриф, называющий CUI, уровень секретности (например, SECRET//NOFORN), ITAR, EAR или экспортный контроль либо Distribution Statement B–F, не сохраняется: “Облачный сервис Holarch не может хранить CUI, секретную информацию или информацию под экспортным контролем, поэтому этот гриф здесь использовать нельзя. Уберите его или используйте настольное приложение или собственную установку.” Уведомления компании, такие как Company Confidential, Distribution Statement A, авторское право и номера контрактов, остаются доступны. Грифы, заданные до этого правила, сохраняются и по-прежнему печатаются; чтобы изменить такой гриф, уберите ограниченную часть.
Настольное приложение и собственные установки предлагают весь список и принимают любой гриф. Грифы — это выбранный вами текст; Holarch печатает их, но не обеспечивает соблюдение правил обращения, и действуют собственные меры контроля вашей организации. В любой редакции уведомление об экспортном контроле в грифе отключает ИИ для проекта.
Список Стандартный гриф заполняет текст за вас:
| Стандартный гриф | Заголовок | Нижний колонтитул | Уведомление |
|---|---|---|---|
| Company Proprietary | COMPANY PROPRIETARY | COMPANY PROPRIETARY | Уведомление о собственности, называющее Компания |
| Company Confidential | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | Уведомление о конфиденциальности, называющее Компания |
| Distribution Statement A–F (B–F: только настольное приложение и собственная установка) | (нет) | DISTRIBUTION STATEMENT A to F | Стандартная формулировка заявления DoD (DoDI 5230.24) с заполненными полями Причина, Дата определения и Контролирующее ведомство |
| Уведомление об экспортном контроле (ITAR/EAR) (только настольное приложение и собственная установка) | (нет) | Export-controlled technical data. See the notice on the first page. | Предупреждение о том, что документ может содержать технические данные, подпадающие под ITAR (22 CFR 120–130) или EAR (15 CFR 730–774) |
| Авторское право | (нет) | © Год Правообладатель. All rights reserved. | (нет) |
| Номер контракта | (нет) | Contract No. Номер контракта | (нет) |
Незаполненное поле остаётся в тексте как заполнитель в квадратных скобках, например [reason]. Тогда редактор показывает “Заполните части в квадратных скобках перед экспортом.”
Задание грифа проекта
- Нажмите ⌘K / Ctrl+K и выберите Гриф проекта…. Его также можно открыть из Параметры страницы… в документе или из Параметры проекта… (Главная ▾ на главной странице) открытого проекта.
- Выберите Собственный гриф.
- В Стандартный гриф выберите запись, заполните её поля (например, Компания) и нажмите Добавить в гриф.
Поля Заголовок, Нижний колонтитул и Уведомление заполнены. Добавьте ещё одну запись, чтобы объединить их: верхние и нижние колонтитулы соединяются через “ · ”, а каждое уведомление становится отдельным абзацем.
- При необходимости измените текст, затем нажмите Сохранить.
Уведомление сообщает “Гриф проекта сохранён.” Изменять гриф проекта могут только владельцы проекта; другие участники видят его только для чтения.
Очистить очищает три поля. Без грифа отключает гриф для проекта, даже если у организации он есть.
Задание грифа организации
- Откройте меню учётной записи, выберите Настройки организации, затем откройте организацию.
- В разделе Гриф документа нажмите Изменить гриф….
- Задайте гриф так же, как для проекта, и нажмите Сохранить.
Уведомление сообщает “Гриф организации сохранён.” Он применяется к каждому проекту организации, у которого нет собственного грифа. Изменять его могут только администраторы организации.
Собственный гриф, титульная страница и номера страниц документа
- В документе откройте Поставка ▾ и выберите Параметры страницы….
- В разделе Гриф выберите один вариант:
- Гриф проекта или организации (по умолчанию): строка ниже называет гриф, который использует документ.
- Собственный гриф: задайте верхний колонтитул, нижний колонтитул и уведомление, как для проекта.
- Без грифа: документ и его экспорт не несут грифа.
- Заполните остальное:
- Титульная страница с полями Версия и Подготовил. Титульная страница также показывает уведомление.
- Номера страниц (“Page X of Y”) при экспорте в Word.
- Нажмите Применить.
Уведомление сообщает “Параметры страницы сохранены.” Верхний и нижний колонтитулы появляются вверху и внизу документа, а уведомление — под его заголовком. ⌘Z / Ctrl+Z отменяет изменение за один шаг.
Побеждает ближайший гриф: собственный гриф документа, иначе гриф проекта, иначе гриф организации.
Где печатаются грифы
- Вид документа и Печать или PDF…: верхний и нижний колонтитулы вверху и внизу каждой страницы, уведомление под заголовком.
- Экспорт в Word (Поставка ▾ → {template} (Word) или Документ (Word) в Все экспорты…): верхний и нижний колонтитулы повторяются на каждой странице, с номерами страниц, если они выбраны, а титульная страница заменяет простой заголовок. Динамический блок матрицы в документе становится таблицей Word с заголовком над ней, той же шириной столбцов и заголовками I/A/D/T, а его пробелы закрашиваются красным.
- Экспортировать матрицу и Матрица прослеживаемости (Word) или (HTML).
- Другие файлы Word: документ ICD, презентация, диаграмма и экспорт Декомпозиция (Word) несут верхний и нижний колонтитулы на каждой странице и уведомление под заголовком.
- Отчёты Excel: верхний и нижний колонтитулы попадают в колонтитулы страницы каждого листа, которые Excel показывает в режиме разметки страницы и печатает.
- CSV: только если отметить Гриф в первой строке в Таблица (CSV). По умолчанию выключено, поэтому файл снова импортируется как есть.
- Изображения диаграмм: экспорт PNG и SVG получает полосу над диаграммой с верхним колонтитулом и полосу под ней с нижним колонтитулом и уведомлением. Экспорт Веб-страница (HTML) показывает их вверху и внизу страницы. Эскизы и изображения диаграмм внутри документов остаются без грифа.
- Презентации: слайды PowerPoint, веб-страницы, PNG и SVG показывают верхний и нижний колонтитулы на каждом слайде и уведомление на первом слайде.
- У сборника свои параметры страницы, которые используются при экспорте сборника.
Проверки модели
Проверки модели сообщают о динамическом значении или динамической таблице, указывающих на что-то удалённое (правило Global.7, “Живые значения, указывающие на отсутствующие цели”):
- Динамическое значение, сущность которого удалена, показывает “{Entity: … Not found}”.
- Блок матрицы, документ области которого удалён, блок Отчёт об испытаниях, набор тестов или цикл тестирования которого удалён, или Пользовательская матрица, связь которой больше не существует.
- Количество или сумма или Динамическая таблица, запрос которых называет несуществующий класс, метку, связь или документ.
- Перекрёстная ссылка, элемент, рисунок или таблица которой удалены.
Откройте описание, затем измените или уберите динамическое значение либо вставьте его заново для существующей цели. См. Проверки модели.
Советы
- Поместите RVTM или VCRM в конец спецификации как раздел верификации; она остаётся актуальной до рецензирования.
- Для пакета рецензирования создайте сборник и задайте ему титульную страницу и гриф в его собственных параметрах страницы.
- Экспортируйте VCRM в Excel для комиссии по рецензированию, которая делает в нём пометки, а динамический блок оставьте в документе.
- Для плана верификации, организованного по уровням интеграции, используйте VCRM по уровням верификации и сначала задайте Уровень верификации каждого требования.
- Для документа управления интерфейсами вставьте Матрица интерфейсов с областью системного Asset, чтобы его дочерние элементы и их Conduit появились на диагонали и в ячейках.