Вимоги
Генерування документів
Вставляйте в документи живі матриці простежуваності, верифікації та інтерфейсів і звіти про тестування, експортуйте їх у чотирьох форматах, будуйте їх з базової лінії та додавайте грифи: повідомлення компанії, заяву про розповсюдження DoD, повідомлення про експортний контроль, авторське право або номер контракту на кожній сторінці та в кожному експорті.
На цій сторінці
Огляд
Holarch будує документи поставки з моделі, тож документ завжди відповідає вимогам, тестам і зв’язкам, що стоять за ним. Три інструменти покривають те, що зазвичай просять рецензенти:
- Матричні блоки: матриця простежуваності, верифікації чи інтерфейсів або звіт про тестування в тексті документа, що оновлюється щоразу, коли змінюється модель.
- Експортувати матрицю: ті самі матриці та звіт про тестування як окремий файл Excel, Word, CSV або вебсторінка, з поточної моделі або з базової лінії.
- Грифи та параметри сторінки: гриф для організації, проєкту або одного документа (повідомлення компанії, положення про розповсюдження, повідомлення про експортний контроль, авторське право чи номер контракту) на кожному експорті, а також титульна сторінка й номери сторінок для Word.
Живі значення й таблиці в тексті описано на сторінці Документи: Живе значення… вставляє один атрибут сутності, Кількість або сума… — число, обчислене із запиту, Жива таблиця… — таблицю із запиту, а Перехресне посилання… — поточний номер розділу, рисунка або таблиці.
Поняття
Матриці
| Матриця | Рядки | Стовпці | Виділяється як прогалина |
|---|---|---|---|
| RTM (матриця простежуваності вимог) | Вимоги | Number, Requirement, Parent, Traced From, Traced To, Satisfied By | Вимога без батька й без нічого, з чого вона простежується |
| Матриця декомпозиції вимог | Вимоги | Number, Requirement, Flows Down From, Flows Down To, Derived Requirements | Вимога верхнього рівня без дочірньої та без похідної вимоги |
| Матриця розподілу вимог | Вимоги | Number, Requirement, Components, Functions, Other | Вимога, яку ніщо не задовольняє |
| Матриця відповідності (показується, коли ввімкнено формальну програму) | Вимоги специфікації замовника | Number, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/Waiver | Вимога без твердження про відповідність (Not assessed) |
| RVTM (матриця простежуваності верифікації вимог) | Вимоги | Number, Requirement, Method, Level, Verified By, Status | Немає методу верифікації або тестового випадку, що верифікує |
| VCRM (матриця перехресних посилань верифікації) | Вимоги | Number, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, Status | Метод верифікації не вибрано |
| VCRM за рівнем верифікації | Вимоги | Number, Requirement, потім I, A, D і T під кожним рівнем верифікації, Verified By, Status | Немає методу верифікації або рівня верифікації |
| Звіт про тестування | Тестові випадки тестового циклу | Number, Test Case, Verifies, Status, Actual Result, Run | Тестовий випадок, який не пройшов у циклі |
| Матриця розподілу | Функції (Actions) | Number, Function, Performed By | Функція, яку не виконує жоден компонент |
| Матриця інтерфейсів | Компоненти (Assets) | Ті самі компоненти; клітинка перелічує Conduits від компонента рядка до компонента стовпця | Компонент без Conduit до інших чи від них |
| Матриця N² | Функції (Actions) | Ті самі функції; клітинка перелічує Input/Outputs, які генерує функція рядка й отримує функція стовпця | Функція, що не обмінюється жодним входом чи виходом |
| Власна матриця | Сутності з пошукового запиту | Сутності з другого запиту; клітинка називає зв’язки між ними або показує X для одного вибраного зв’язку | Рядок без зв’язку з будь-яким стовпцем |
- Parent — вимога, яку рядок декомпозує. Traced From, Traced To і Satisfied By перелічують пов’язані сутності. У матриці декомпозиції Derived Requirements — це вимоги, до яких рядок traces to.
- У VCRM X позначає кожен запланований метод; Status — поточний результат верифікації, зведений із тестових випадків, як у Центрі тестування.
- У VCRM за рівнем верифікації стовпці згруповано за рівнями атрибута Verification Level (Component, Subsystem, System). X стоїть під рівнем вимоги та кожним її запланованим методом.
- Тестові випадки ніколи не перелічуються як функції: матриці розподілу та N² показують Actions, які не є Test Cases.
- Область: матриця охоплює сутності одного документа (у порядку й нумерації документа), усі частини збірки або весь проєкт. Матриця розподілу використовує функції документа або всі функції, якщо в документі їх немає. Матриці інтерфейсів і 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 текстові стовпці широкі, а стовпці методів верифікації вузькі, із заголовками I, A, D і T та легендою під таблицею (I = Inspection, A = Analysis, D = Demonstration, T = Test). Матриці з більш ніж п’ятьма стовпцями використовують альбомну сторінку. VCRM за рівнем має другий рядок заголовка з рівнями; матриці інтерфейсів, N² і власні затіняють заголовки рядків і діагональ.
Матриці з базової лінії
Підписаний документ поставки має показувати модель такою, якою її зафіксовано в базовій лінії, а не такою, як сьогодні. Матриця, побудована з базової лінії, використовує сутності та зв’язки базової лінії, а її заголовок закінчується на “(базова лінія назва)”.
- Експортувати матрицю: виберіть базову лінію в Модель.
- Базова лінія проєкту містить усю модель, тож кожна матриця працює з неї.
- Базова лінія документа містить документ, його елементи та зв’язані з ними сутності. Матриці цього документа повні. Матриця, що виходить за межі документа (увесь проєкт або матриця інтерфейсів чи N²), має примітку “Побудовано з базової лінії документа, яка містить лише цей документ і зв’язані з ним сутності.”
Звіти про тестування
Звіт про тестування подає результати одного тестового циклу: що тестували, на якій конфігурації, що пройшло й що не пройшло та які вимоги це верифікує.
- У Центрі тестування зафіксуйте тестовий цикл командою Почати новий цикл…. Введіть Конфігурація / збірка і Об’єкт випробування (обидва поля спочатку мають значення, найчастіше записані в прогоні).
- На картці набору відкрийте ⋯ і виберіть Звіт про тестування…. Або відкрийте ⋯ → Тестові цикли… і натисніть Звіт… на циклі.
- В Експортувати звіт про тестування виберіть Тестовий цикл і в Експортувати як — Звіт про тестування (Word), (Excel), (CSV) або (HTML), потім натисніть Експортувати.
Звіт Word (типовий) має такі розділи:
- Ідентифікація: тестовий набір, тестовий цикл, коли збережено результати та коли створено звіт.
- Тестове середовище й конфігурація: конфігурація або збірка, об’єкт випробування, тестувальники й дати прогонів.
- Зведення результатів: кількості за статусом і частка успішних.
- Результати за тестовими випадками: один рядок на тестовий випадок.
- Докладні результати: для кожного тестового випадку очікуваний і фактичний результат, тестувальник, дата, конфігурація, об’єкт випробування, файл доказів і результати кроків.
- Відхилення й відкриті проблеми: невдалі й заблоковані тестові випадки з їхніми зв’язаними Issues.
- Докази тестування: файли доказів, записані в циклі.
- Статус верифікації вимог: вимоги, які верифікує набір, з їхнім статусом за результатами цього циклу.
Excel дає три аркуші (Results, Steps, Requirements); CSV і вебсторінка дають таблицю результатів. Результати беруться з циклу в збереженому вигляді, тож звіт не змінюється після скидання набору. Назви, верифіковані вимоги й Issues беруться з поточної моделі. Цикли, збережені до того, як почали зберігатися результати кроків і докази, показують ці поля як “—”.
Щоб вставити таблицю результатів у документ, вставте матричний блок Звіт про тестування (див. вище).
Грифи документів і експорту
Гриф — це текст, який Holarch друкує на всьому, що ви експортуєте: верхній колонтитул угорі кожної сторінки, нижній колонтитул унизу кожної сторінки та повідомлення на першій сторінці. Задайте його один раз для проєкту або для організації, і кожен експорт його міститиме. Документ може замінити його власним.
Примітка: хмарний сервіс (app.holarch.app) не може зберігати CUI, секретну або підконтрольну експортному контролю інформацію (Умови використання). Там стандартний список не містить Distribution Statements від B до F і повідомлення про експортний контроль, а гриф, що називає CUI, рівень секретності (наприклад, SECRET//NOFORN), ITAR, EAR чи експортний контроль або Distribution Statements від 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 і виберіть Гриф проєкту…. Його також можна відкрити з Параметри сторінки… у документі або з Параметри проєкту… (Головна ▾ на головній сторінці) відкритого проєкту.
- Виберіть Власний гриф.
- У Стандартний гриф виберіть запис, заповніть його поля (наприклад, Компанія) і натисніть Додати до грифа.
Ви бачите заповнені Заголовок, Нижній колонтитул і Повідомлення. Додайте інший запис, щоб поєднати їх: верхні й нижні колонтитули з’єднуються через “ · ”, а кожне повідомлення стає окремим абзацом.
- За потреби відредагуйте текст, потім натисніть Зберегти.
Сповіщення показує “Гриф проєкту збережено.” Змінювати гриф проєкту можуть лише власники проєкту; інші учасники бачать його лише для читання.
Очистити спорожнює три поля. Без грифа вимикає гриф для проєкту, навіть якщо організація має гриф.
Встановлення грифа організації
- Відкрийте меню облікового запису, виберіть Налаштування організації і відкрийте організацію.
- У розділі Гриф документа натисніть Редагувати гриф….
- Задайте гриф так само, як для проєкту, і натисніть Зберегти.
Сповіщення показує “Гриф організації збережено.” Він застосовується до кожного проєкту організації, що не має власного грифа. Змінювати його можуть лише адміністратори організації.
Власний гриф документа, титульна сторінка й номери сторінок
- У документі відкрийте Видати ▾ і виберіть Параметри сторінки….
- У розділі Гриф виберіть один варіант:
- Гриф проєкту або організації (типово): рядок нижче називає гриф, який використовує документ.
- Власний гриф: задайте верхній колонтитул, нижній колонтитул і повідомлення так само, як для проєкту.
- Без грифа: документ і його експорт не мають грифа.
- Заповніть решту:
- Титульна сторінка, з Версія і Підготував. Титульна сторінка також показує повідомлення.
- Номери сторінок (“Сторінка X з 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, “Live values pointing to missing targets”):
- Живе значення, сутність якого видалено, показує “{Entity: … Not found}”.
- Матричний блок, документ області якого видалено, блок Звіт про тестування, тестовий набір або тестовий цикл якого видалено, або Власна матриця, зв’язок якої більше не існує.
- Кількість або сума чи Жива таблиця, запит яких називає клас, мітку, зв’язок або документ, якого не існує.
- Перехресне посилання, елемент, рисунок або таблицю якого видалено.
Відкрийте опис, потім відредагуйте або вилучіть живе значення чи вставте його знову для наявної цілі. Див. Перевірки моделі.
Поради
- Розмістіть RVTM або VCRM наприкінці специфікації як її розділ верифікації; він залишається актуальним до рецензування.
- Для пакета рецензування побудуйте збірку і задайте їй титульну сторінку та гриф у її власних параметрах сторінки.
- Експортуйте VCRM в Excel для комісії з рецензування, яка робить у ньому позначки, а живий блок залиште в документі.
- Для плану верифікації, упорядкованого за рівнями інтеграції, використайте VCRM за рівнем верифікації і спершу задайте Verification Level кожної вимоги.
- Для документа контролю інтерфейсів вставте Матриця інтерфейсів з областю системного Asset, щоб його дочірні елементи та їхні Conduits з’явилися на діагоналі й у клітинках.