Вимоги
Вимоги
Пишіть, перевіряйте, затверджуйте, фіксуйте в базовій лінії та імпортуйте вимоги, відстежуйте відкриті елементи TBD/TBR і зв’язки для перевірки.
На цій сторінці
- Огляд
- Поняття
- Як користуватися
- Коли й навіщо
- Написати вимогу
- Перевірити формулювання
- Писати за шаблонами EARS
- Затвердити вимоги
- Зафіксувати документ для рецензування
- Опрацювати зміну після базової лінії
- Закрити елементи TBD і TBR
- Імпортувати наявну специфікацію
- Робочий приклад: демопроєкт CubeSat EO-1
- Поради та добрі практики
- Типові помилки
- Як це пов’язано з іншими функціями
- Сторінка “Вимоги”
- Якість вимог
- Затвердження
- Реєстр TBD/TBR
- Зв’язки для перевірки
- Базові лінії й порівняння версій
- Імпорт вимог
- Клавіатурні скорочення для вимог
- Налаштування
- Повідомлення
- Обмеження
- Пов’язане
Огляд
Використовуйте сторінки вимог, щоб писати, перевіряти, затверджувати вимоги й фіксувати їх у базових лініях, а також відстежувати, що ще відкрите. Вимога — це сутність класу LML Requirement: можливість, характеристика чи чинник якості, які система повинна мати.
Вимоги зазвичай містяться в документі вимог (див. Документи). Кожна з них однаково є сутністю моделі. Тож та сама вимога з’являється в Базі даних, на діаграмах, у Матриці простежуваності та в RVTM.
Група Потреби та вимоги на панелі навігації містить усі сторінки вимог:
| Сторінка | Що показує |
|---|---|
| Документи | Специфікації та їхні структури. Вимоги пишуться тут. |
| Вимоги | Кожна вимога в одній таблиці (База даних, відфільтрована за class:Requirement). |
| Якість | Якість вимог: оцінка за дев’ятьма критеріями для кожної вимоги. |
| TBD/TBR | Реєстр відкритих значень, які ще треба визначити або переглянути. |
| Зв’язки для перевірки | Зв’язки, вимога вище за ланцюгом яких змінилася після останнього перегляду зв’язку. |
| Затвердження | Вимоги, Status яких — In Review. |
| Імпорт і експорт | Імпорт для Word, Excel, CSV, ReqIF, звичайного тексту, XMI і файлів проєктів через одну зону перетягування, а також експорт моделі. |
Базові лінії — зафіксовані знімки для рецензувань. Створюйте їх з документа або з Контроль і рецензування → Базові лінії та версії. Зв’язки з функціями, активами й тестами описано в розділі Простежуваність.
Поняття
Requirement і Statement
Statement — батьківський клас Requirement.
- Використовуйте Statement для тексту, що не є обов’язковим: заголовків розділів, припущень, контексту.
- Використовуйте Requirement для кожного обов’язкового твердження з “shall”.
Лише Requirements оцінюються перевіркою якості, перелічуються в реєстрі TBD/TBR, позначаються для перегляду, коли змінюються, і враховуються в RVTM. Statements пропускаються.
Вимога має спільні поля сутності Номер, Назва і Опис. Опис — це саме твердження вимоги як форматований текст. Атрибути нижче додають решту.
Атрибути вимоги
| Атрибут | Тип і значення | Значення |
|---|---|---|
| Обґрунтування | Довгий текст | Причина, що стоїть за вимогою. |
| Статус | Draft, In Review, Approved, Rejected | Де перебуває вимога в робочому процесі затвердження. |
| Priority | High, Medium, Low | Наскільки вимога важлива для зацікавлених сторін. |
| Criticality | High, Medium, Low | Наслідки для місії чи безпеки, якщо вимогу не виконано. |
| Власник | Текст | Особа чи команда, відповідальна за вимогу. |
| Джерело | Текст | Зацікавлена сторона, документ чи стандарт, з якого походить вимога. |
| Verification Method | Множинний вибір: Analysis, Demonstration, Inspection, Test | Як верифікується вимога. |
| Verification Level | Component, Subsystem, System | Рівень складання, на якому верифікується вимога. |
| Success Criteria | Довгий текст | Вимірюваний результат, що показує виконання вимоги. |
| TBD/TBR | None, TBD, TBR | TBD = значення ще треба визначити; 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, Due date, TBD/TBR, TBD Owner, TBD Due Date), Верифікація (Verification Method і Level, Verified by і поля закриття з формальною програмою), Значення (Budget Quantity, Threshold, Objective і поточне Value, Units), Відповідність (формальна програма) і Якість.
Оцінка й дев’ять критеріїв розташовані в групі Якість, спершу згорнутій. Її заголовок показує, наприклад, “89% · виконано 8 з 9” або “ще не перевірено”. Holarch запам’ятовує для кожного класу, чи ви залишили групу відкритою.
Проєкти можуть додавати власні атрибути вимог і варіанти; див. Розширення схеми.
Мітки вимог
Мітки класифікують вимоги, не змінюючи їхнього класу. Вбудовані мітки вимог:
- Functional Requirement, Performance Requirement, Interface Requirement.
- Environmental Requirement, Reliability Requirement, Safety Requirement.
- Verification Requirement.
- Stakeholder Need: потреба, висловлена зацікавленою стороною, перш ніж її перетворено на системні вимоги.
Verification Method — також група міток з мітками Analysis, Demonstration, Inspection і Test. Мітка й атрибут залишаються синхронізованими в тому самому кроці відміни:
- Додавання мітки Test задає Verification Method значення Test.
- Вибір Test в атрибуті додає мітку.
Старіші проєкти й імпорти, що містять лише мітки, об’єднуються в атрибут під час відкриття проєкту.
Робочий процес вимог
Кожна вимога проходить чотири статуси:
- Draft: пишеться.
- In Review: очікує рішення. Перелічується на сторінці “Затвердження”.
- Approved або Rejected: рішення ухвалено. Кожне рішення записує, хто його ухвалив, коли, і необов’язкову причину.
Після затвердження три механізми підтримують чесність запису:
- Повторне рецензування після редагування. Редагування назви чи опису вимоги зі статусом Approved повертає її в In Review з приміткою “Текст змінено після затвердження”.
- Застаріла якість. Редагування назви чи опису позначає результати якості застарілими й очищує ручні перевизначення якості.
- Зв’язки для перевірки. Редагування назви, опису чи ключового атрибута позначає для перегляду зв’язки з елементами нижче за ланцюгом.
Усі три є частиною редагування, тож одне натискання “Відмінити” (⌘Z / Ctrl+Z) скасовує їх разом.
Відкриті елементи: TBD, TBR і TBS
Відкритий елемент — це значення, яке ще не встановлено. Вимога є відкритим елементом, коли виконується будь-яка з умов:
- Її атрибут TBD/TBR має значення TBD або TBR.
- Її назва чи опис містить слово TBD, TBR або TBS.
Відкриті елементи з’являються в реєстрі TBD/TBR, доки їх не закрито.
Базові лінії
Базова лінія — знімок лише для читання. Є два види:
- Базова лінія документа містить один документ. Вона включає артефакт документа, його елементи та їхні атрибути, зв’язки, що їх стосуються, сутності на відстані одного кроку й налаштування структури документа.
- Базова лінія проєкту містить кожну сутність і кожен зв’язок проєкту.
Базові лінії можуть містити записи про затвердження (ім’я, роль, заява, дата). Після збереження записи блокуються.
Як користуватися
Коли й навіщо
Робота з вимогами охоплює ліву сторону V-моделі системної інженерії:
- Зібрати потреби зацікавлених сторін.
- Вивести системні вимоги.
- Перевірити, що кожне твердження правильно сформульоване.
- Отримати затвердження вимог.
- Зафіксувати їх на рецензуванні (SRR, PDR, CDR).
Після базової лінії робота переходить до контролю змін. Кожна зміна проходить повторне рецензування, а її вплив нижче за ланцюгом перевіряється. Відкриті значення TBD/TBR закриваються, перш ніж проєктне рішення затверджено.
Сторінки вимог відповідають на такі запитання:
| Запитання | Сторінка |
|---|---|
| Чи добре написана кожна вимога? | Якість |
| Які значення досі невідомі, хто за них відповідає і чи прострочені вони? | TBD/TBR |
| Що треба перевірити знову, бо вимога змінилася? | Зв’язки для перевірки |
| Що очікує рішення? | Затвердження |
| Що змінилося після рецензування? | Документ: Версія ▾ → Порівняти версії…, Базові лінії та версії |
| Чи розподілено й верифіковано кожну вимогу? | Матриця простежуваності і RVTM |
Сторінки “Якість”, “Зв’язки для перевірки”, “TBD/TBR” і “Затвердження” розташовані поруч у групі Потреби та вимоги на панелі навігації. Пройдіть звідти всі чотири перевірки по черзі.
Написати вимогу
- Відкрийте Потреби та вимоги → Документи.
- Відкрийте документ вимог.
Щоб почати новий, натисніть + Новий документ (див. Документи).
- На панелі Швидке додавання під документом виберіть, куди йде елемент, наприклад Під 3 Electrical Power.
- Введіть твердження вимоги й натисніть Enter.
Holarch додає елемент типового класу документа (Requirement у документі вимог). Він нумерується після своїх сусідніх елементів.
- Вибравши вимогу, відкрийте інспектор праворуч.
- Заповніть Обґрунтування, Джерело і Критерії успіху у групі Requirement, Пріоритет, Criticality і Власник у групі Робочий процес, а також Verification Method і Рівень верифікації у групі Верифікація.
- Додайте мітку типу через + Мітка у групі Requirement інспектора, наприклад Performance Requirement. (Стовпець Мітки є в Вигляд ▾ → Стовпці ▸.)
Вимога має Status Draft і з’являється в Потреби та вимоги → Вимоги.
Якщо значення ще невідоме:
- Запишіть у твердженні свою найкращу оцінку.
- Задайте TBD/TBR значення TBD.
- Заповніть TBD Owner і задайте дату в Термін у групі Робочий процес.
Тепер вимога також з’являється в реєстрі TBD/TBR із цим терміном.
Перевірити формулювання
- Відкрийте Потреби та вимоги → Якість.
Натомість із документа виберіть Перевірити ▾ → Перевірити якість.
- На панелі області виберіть Усі вимоги або Документ: <name>.
- Натисніть Перевірити якість у заголовку сторінки.
Сповіщення показує “Перевірено вимог: 32” (або вашу кількість). Кожна вимога отримує оцінку від 0 до 100% і ✔ чи ✘ за кожним критерієм.
Якщо вимог понад 2,000, перевірка виконується у фоновому режимі: картка поступу показує “Перевірка вимог”, кількість і час, що залишився, і ви можете продовжувати роботу. Натисніть Скасувати на картці, щоб зупинити; нічого не змінюється. Потім картка показує “Збереження результатів якості” з кількістю збережених; під час збереження інші зміни відхиляються з повідомленням “Збереження результатів якості. Спробуйте знову, коли воно завершиться.” Зберігаються лише вимоги, результати яких змінилися, тож повторна перевірка без змін нічого не зберігає. Уся перевірка — один крок: один ⌘Z / Ctrl+Z вилучає її.
- Прочитайте плитки: Вимоги, Середня оцінка, Добра (≥ 67%), Потребує доопрацювання (< 67%) і, якщо такі є, Застаріло (текст змінено).
- Для кожної вимоги нижче 67% прочитайте стовпець Пропозиції.
Або наведіть вказівник на ✘, щоб побачити повідомлення за цим критерієм.
- Натисніть назву вимоги, щоб відкрити її, і виправте текст.
- Запустіть перевірку знову.
Correct і Feasible завжди потребують судження людини. Перевірка ніколи не позначає їх виконаними, хоч би що знайшли інші перевірки. Тож автоматична перевірка досягає щонайбільше 7 з 9 критеріїв (78%). Вимога без верифікаційного тесту чи вимоги досягає 6 з 9 (67%). Для кожної вимоги вирішіть їх самі:
- Переглянувши вимогу, натисніть ✘, щоб позначити критерій як Так.
- Для першої думки скористайтеся ✦ ШІ ▾ → Перевірити за допомогою ШІ (N вимог)… (Перевірка вимог ШІ).
Примітка: оцінки, збережені попередніми версіями, могли зараховувати Correct чи Feasible як виконані, коли інша перевірка не проходила. Запустіть перевірку знову, щоб оновити їх.
Писати за шаблонами EARS
EARS (Easy Approach to Requirements Syntax) записує кожну вимогу одним реченням: необов’язкова умова, потім “the [system] shall [response]”. Перше слово умови задає шаблон.
| Шаблон | Заготовка | Приклад |
|---|---|---|
| Ubiquitous | The [system] shall [response]. | The pump controller shall record every start command with its time. |
| Event-driven | When [trigger], the [system] shall [response]. | When the tank level falls below 20 %, the pump controller shall start the backup pump. |
| State-driven | While [state], the [system] shall [response]. | While the vehicle is charging, the battery manager shall keep each cell below 45 °C. |
| Unwanted behavior | If [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 feature | Where [feature is included], the [system] shall [response]. | Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes. |
| Complex | While [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. |
- Відкрийте вимогу в інспекторі або Поданні елемента.
- Натисніть EARS ▾ біля Опис.
Перший рядок показує шаблон твердження (✓ Event-driven) або що треба виправити (Немає шаблону EARS: виправити 1).
- Виберіть шаблон.
Його заготовка стає описом. Якщо вимога вже має опис, підтвердьте через Замінити; старе твердження залишається в історії елемента. Один ⌘Z / Ctrl+Z відміняє це.
- Замініть слова у квадратних дужках.
Щоб перевіряти кожну вимогу, задайте Requirement.11 значення Попередження або Помилка в Перевірки моделі → Налаштування. Типово правило вимкнено.
У проєкті SysML v2 EARS ▾ розташовано під Документація вимоги в інспекторі, і воно записує її коментар doc.
Затвердити вимоги
- Коли вимога готова, задайте її Status значення In Review.
Зробіть це в інспекторі (Status на смузі рецензування групи Робочий процес), у Базі даних або в стовпці документа.
- Рецензент відкриває Потреби та вимоги → Затвердження.
Сторінка перелічує кожну вимогу, Status якої — In Review.
- Натисніть рядок.
Група Робочий процес інспектора показує смугу рецензування: Status, хто й коли його задав (“by J. Rivera · Mar 9, 2026 at 9:58 AM”) і кнопки.
- Натисніть Затвердити.
Або натисніть Відхилити… і введіть необов’язкову причину.
Сповіщення показує “Затверджено” або “Відхилено”. Рішення записується з вашим іменем і часом, а вимога залишає список “Затвердження”.
Коли вимога є в базовій лінії і до неї простежуються елементи верифікації чи документи, Затвердити спершу відкриває діалог, що перелічує їх у розділі Потребує повторного перегляду (Вплив). Натисніть рядок, щоб переглянути його, потім натисніть Затвердити, щоб підтвердити.
Щоб повернути вирішену вимогу на рецензування, натисніть Відкрити знову. Сповіщення показує “Переміщено в In Review”.
Якщо проєкт має робочий процес для Status вимог (Схема → Робочий процес), смуга рецензування показує переходи цього робочого процесу замість Затвердити, Відхилити… і Відкрити знову. Перехід, що потребує затвердження, закінчується на … і відкриває Запитати затвердження: див. Запит на затвердження зміни стану. Для вимоги в базовій лінії Запитати затвердження і діалог Затвердити… запиту на зміну показують той самий список Потребує повторного перегляду.
Зафіксувати документ для рецензування
- В основному написі документа натисніть Версія ▾.
- Виберіть Зберегти базову лінію….
Або виберіть Видати ▾ → Версія ▸ Зберегти базову лінію….
- Залиште або змініть Назву. Типово — “<document> Baseline <n>”.
- У розділі Затвердження заповніть по рядку на кожного затверджувача: Ім’я, Роль і Заява (типово “Затверджено до випуску.”).
+ Додати затверджувача додає рядок; × вилучає його.
- Натисніть Створити.
Сповіщення показує “Базову лінію збережено”. Версія ▾ показує “Поточна · остання базова лінія <name>”.
Відтепер кожен рядок отримує смугу зміни, коли відрізняється від останньої базової лінії.
Опрацювати зміну після базової лінії
- Відредагуйте текст вимоги в документі.
Сповіщення підсумовує, що сталося, наприклад “1 затверджену вимогу переміщено в In Review; 6 зв’язків позначено для перегляду.” Як частина вашого редагування (одне натискання “Відмінити” повертає все назад):
- Вимога зі статусом Approved переходить в In Review.
- Її результати якості стають застарілими (“Якість: застаріла — запустіть знову”).
- Її зв’язки нижче за ланцюгом позначаються для перегляду.
- Відкрийте Потреби та вимоги → Зв’язки для перевірки.
- Для кожного рядка натисніть Порівняння, щоб побачити зміну тексту, і перегляньте пов’язаний елемент.
- Коли пов’язаний елемент досі чинний, натисніть Позначити перевіреним… у його рядку.
Щоб позначити кілька одразу, виберіть їхні рядки й натисніть Позначити вибрані перевіреними….
- Опишіть, що ви перевірили, і натисніть Позначити перевіреним.
- Знову запустіть перевірку якості.
- Знову проведіть вимогу через затвердження.
- Натисніть Версія ▾ → Порівняти версії…, виберіть базову лінію в Від і Поточна версія в До.
Звіт перелічує кожну зміну після базової лінії.
- Натисніть Зміни (Excel) для ради зі змін.
Закрити елементи TBD і TBR
- Відкрийте Потреби та вимоги → TBD/TBR.
- Прочитайте плитки: Відкриті TBD/TBR, Прострочені, Без власника і кількість для кожного документа.
- Спершу опрацюйте прострочені рядки. Вони підфарбовані, з написом “Прострочено” під терміном.
- Де власник показує “—”, призначте TBD Owner.
- Коли значення встановлено, відредагуйте текст вимоги до остаточного значення.
- Натисніть Закрити в рядку.
Закриття задає TBD/TBR значення None, і рядок залишає реєстр.
Щоб надіслати реєстр власникам, натисніть Експортувати XLSX.
Імпортувати наявну специфікацію
- Відкрийте Потреби та вимоги → Імпорт і експорт.
- Перетягніть файл у зону перетягування або натисніть її, щоб вибрати файл: Word (.docx), Excel чи CSV, ReqIF або звичайний текст.
Рядок стану показує, наприклад, “Проаналізовано “SRS.docx”: 48 рядків, 5 стовпців.” Формат показує виявлений формат.
- Натисніть Продовжити.
- Перевірте, чому відповідає кожен стовпець, і задайте Клас для рядків без класу значення Requirement.
- Натисніть Продовжити.
- Залиште позначеним Створити документ вимог із цих N вимог, перевірте тип і назву документа, а також нові й оновлені елементи та попередження.
- Натисніть Імпортувати N елементів.
Якщо попереджень немає, Holarch відкриває новий документ. Якщо є, картка Імпорт завершено перелічує їх.
Картка Імпорт завершено має кнопки, щоб відкрити документ, Базу даних, діаграму Spider чи деревоподібну або перевірку якості. Один ⌘Z / Ctrl+Z вилучає весь імпорт.
Робочий приклад: демопроєкт CubeSat EO-1
Створіть демопроєкт CubeSat EO-1 — Earth Observation Demo із Керування проєктами. Він має специфікацію з 32 вимог, SRS-001 EO-1 System Requirements Specification, з базовою лінією SRR і змінами, внесеними після неї.
Якість.
- Відкрийте Потреби та вимоги → Якість і натисніть Перевірити якість.
Плитки показують 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” неоднозначне; вкажіть, чи йдеться про обидва, чи про одне: [and/or]”.
Щоб виправити 2.5:
- Перепишіть її як “The spacecraft shall resume imaging within 6 hours of a safe mode entry.”
- Зв’яжіть тестовий випадок через verified by.
- Запустіть перевірку знову.
Повідомлення про сполучник, застереження й нечіткий термін зникають.
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” на вимогу, в активному стані, з числом, одиницею й умовою. Перевірка якості винагороджує саме це.
- Причину вказуйте в Обґрунтування, а не в твердженні. Звороти мети (“so that”, “in order to”) і дужки позначаються як R20 і R21.
- Заповнюйте Verification Method під час написання. Тоді вимога з методом, але без тестового випадку, показується в RVTM як Лише заплановано, а не як Неверифіковано.
- Задавайте TBD/TBR із власником і терміном, а не лише вводьте “TBD” у тексті. Атрибут дає реєстру власника й термін для відстеження.
- Створюйте базову лінію перед кожним рецензуванням. Смуги змін і Порівняти з поточною працюють лише відносно базової лінії.
- Позначайте зв’язки перевіреними з коментарем. Коментар додається до пов’язаного елемента й записується на зв’язку, тож рецензування залишає журнал аудиту.
Типові помилки
| Симптом | Причина | Виправлення |
|---|---|---|
| Вимога не оцінюється, відсутня в реєстрі або в RVTM. | Це Statement, а не Requirement. | Змініть її клас на Requirement в інспекторі. |
| Correct і Feasible показують ✘ на кожній вимозі. | Вони потребують судження людини (“Потребує судження рецензента”). | Перегляньте кожну й натисніть ✘, щоб позначити Так, або запустіть Перевірку вимог ШІ. |
| Оцінка показує “Застаріло — виконати знову”. | Текст змінився після останньої перевірки. | Натисніть Перевірити якість або ввімкніть Автоматично перевіряти знову, коли змінюється текст. |
| Ручні перевизначення Так/Ні зникли. | Редагування тексту очищає їх. | Задайте їх знову після рецензування; відміна відновлює їх, і вони залишаються в історії. |
| Вимога залишилася Approved після виправлення друкарської помилки. | Будь-яке редагування назви чи опису знову відкриває затверджену вимогу. | Затвердьте її знову. Виправляйте друкарські помилки до затвердження. |
| “Закрити” немає в рядку TBD/TBR. | Відкритий елемент походить лише з тексту. | Відредагуйте текст, щоб вилучити TBD, TBR або TBS. |
| Імпорт створив копії замість оновлення. | Зіставляти наявні сутності за не знайшло збігів. | Експортуйте зі стовпцем ID, відредагуйте й імпортуйте з Зіставляти наявні сутності за: Глобальний ID (див. Оновлення вимог з електронної таблиці). |
Як це пов’язано з іншими функціями
- Отримує дані з: вхідних даних зацікавлених сторін і наявних специфікацій через Імпортувати, а також документів, написаних у Документи.
- Передає дані до:
- Функціональний аналіз: функції, виділені з вимог.
- Матриця простежуваності: satisfied by, verified by.
- RVTM і Центр тестування: стан верифікації.
- Перевірки моделі: правила від Requirement.1 до Requirement.10.
- Головна: кількість затверджень і верифікацій.
- Експорт документа: зауваження щодо якості (Excel), RVTM, VCRM, зміни.
- Рецензування.
- ШІ: меню ✦ ШІ ▾ документа й Подання елемента має Rewrite Clearly…, Add Measurable Criteria…, Simplify…, Split Compound Requirement…, Draft Rationale…, Suggest Name… і Check with AI (Перевірка вимог ШІ). Зміни ШІ попередньо показуються, перш ніж застосуються. Див. Запитати ШІ та інструменти ШІ.
Сторінка “Вимоги”
Використовуйте сторінку “Вимоги”, щоб бачити й редагувати кожну вимогу в одній таблиці. Потреби та вимоги → Вимоги — це База даних, відфільтрована за class:Requirement.
Тут працює кожна функція Бази даних:
- Сортуйте й фільтруйте стовпці та редагуйте клітинки на місці.
- Вибирайте рядки для панелі масових дій, щоб задати атрибути чи мітки багатьом вимогам одразу.
- Експортуйте й відкривайте Матрицю простежуваності для вибраних рядків.
Натисніть рядок, щоб показати вимогу в інспекторі. Двічі клацніть його, щоб відкрити її Подання елемента. Вимога зі зв’язком для перевірки показує значок ⚠ Перевірити у своєму рядку. Клацніть рядок правою кнопкою, щоб відкрити його меню: до трьох запропонованих дій з причинами (наприклад, ✦ Add Measurable Criteria…, коли вимога не проходить Unambiguous, ✦ Згенерувати тестовий випадок…, коли вона не верифікована), ✦ Більше ШІ ▸, потім Відкрити, Перейменувати…, Дублювати, Додати дочірній…, Status ▸, Пріоритет ▸, Зв’язати з ▸, Додати до документа ▸, Показати на діаграмі ▸, Копіювати посилання, Копіювати номер і Видалити… (див. Контекстне меню).
Див. Модель і база даних щодо таблиці, запитів і масового редагування.
Корисні запити:
| Запит | Показує |
|---|---|
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%.
Компонування сторінки
- Заголовок сторінки:
- Більше ▾: Очистити ручні оцінки скидає кожне ручне Так/Ні показаних вимог і повторно запускає перевірку. Відкрити у Вимоги відкриває показані вимоги в таблиці “Вимоги”. Відкрити документ з’являється, коли областю є документ.
- Експорт ▾: Excel (.xlsx) і CSV показаних вимог.
- Перевірити якість: перевіряє кожну вимогу в області, хоч би що показували фільтри (правило дублікатів порівнює кожну вимогу з іншими в області).
- ✦ ШІ ▾ (на верхній панелі): Перевірити за допомогою ШІ (N вимог)…, Перевірка вимог ШІ для показаних вимог.
- Панель області: Область (Усі вимоги або Документ: <name>) і прапорець Автоматично перевіряти знову, коли змінюється текст. Зв’язки для перевірки, TBD/TBR і Затвердження розташовані поруч із Якість на панелі навігації.
- Рядок запиту: + Фільтр, чипи фільтрів і текст пошуку, Очистити, ? (синтаксис пошуку) і Подання ▾: той самий рядок, що й на сторінці “Вимоги” (див. Фільтрування сторінки “Якість”).
- Плитки: Вимоги (“12 з 40” під Показані вимоги, коли фільтри деякі приховують), Середня оцінка, Добра (≥ 67%), Потребує доопрацювання (< 67%) і Застаріло (текст змінено), коли є застарілі. Застарілі оцінки не враховуються в середньому.
- Примітка під плитками: “Автоматичні перевірки охоплюють щонайбільше 7 з 9 атрибутів (78%); Correct і Feasible потребують перевірки людиною — клацніть ✘, щоб позначити Так. Кожне клацання по черзі перемикає ручне Так, ручне Ні й повернення до автоматичного.”
- Таблиця: Номер, Назва (з описом нижче), Оцінка якості, по стовпцю на кожен критерій і Пропозиції. Пропозиції перелічують кожне повідомлення з префіксом критерію. Рядки впорядковано за номером. Клацніть рядок правою кнопкою або натисніть на ньому Shift+F10, щоб відкрити меню рядка Бази даних: запропоновані дії з причинами (першим іде переписування, що виправляє невиконаний критерій), ✦ Більше ШІ ▸, Відкрити, Перейменувати…, Дублювати, Додати дочірній…, Status ▸, Пріоритет ▸, Зв’язати з ▸, Додати до документа ▸, Показати на діаграмі ▸, Копіювати посилання, Копіювати номер і Видалити…. Рядок стає виділенням.
- Кілька рядків: ⌘ / Ctrl-клацання (Ctrl-клацання у Windows і Linux) перемикає рядок, ⇧ / Shift-клацання вибирає діапазон від останнього клацнутого рядка, ⌘ / Ctrl+⇧ / Shift-клацання додає цей діапазон, а ⌘A / Ctrl+A або ⇧ / Shift+↑ / ⇧ / Shift+↓ на сфокусованому рядку вибирають усі рядки або розширюють виділення. Панель інструментів показує кількість; Esc очищує виділення. Клацніть вибраний рядок правою кнопкою, щоб діяти на всі: ✦ Перевірити за допомогою ШІ (n вимог)…, ✦ Переписати (n) ▸, ✦ Згенерувати тестові випадки (n)…, ✦ Запитати ШІ про ці (n)…, ✦ Запропонувати трасування (n)… (кожна з одним попереднім переглядом; див. ШІ для кількох вибраних елементів), Дублювати n сутностей, Задати Status ▸, Задати пріоритет ▸, Додати до документа ▸ і Видалити n елементів…; кожну з них повертає назад одне натискання “Відмінити”. Реєстр TBD/TBR і Зв’язки для перевірки працюють так само; у Зв’язках для перевірки виділення також позначає рядки для Позначити вибрані перевіреними….
Особливі випадки:
- Рядок без результату показує “Не виконано” у стовпці оцінки.
- Застарілий рядок показує “Застаріло — виконати знову”.
- Коли область не має вимог, сторінка показує “Немає вимог” і “Оцінюються лише сутності класу Requirement; Statements пропускаються.”
- Коли фільтри чи текст пошуку приховують кожну вимогу, сторінка показує “Немає відповідних вимог” і “Жодна вимога не відповідає пошуку чи фільтрам. Очистьте їх, щоб побачити всі вимоги.”
Фільтрування сторінки “Якість”
Рядок запиту працює так само, як на сторінці “Вимоги” (див. Як введені фільтри стають чипами): введені умови фільтра стають чипами, коли ви натискаєте Enter, решта тексту шукає збіги з назвою, номером і описом, Backspace у порожньому пошуку вилучає останній чип, а Очистити вилучає всі. Плитки, таблиця, Експорт ▾ і ✦ ШІ ▾ → Перевірити за допомогою ШІ дотримуються фільтрів.
+ Фільтр перелічує, з кількостями для області:
| Група | Фільтри | Умова |
|---|---|---|
| Якість | Добра (≥ 67%), Потребує доопрацювання (< 67%), Не виконано, Застаріло (текст змінено), Ручні оцінки, Зауваження ШІ | quality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai |
| Не проходить критерій | По одному на критерій: оцінено як Ні | quality:Verifiable=no (=yes: оцінено як Так) |
| Зауваження правила | Правила, знайдені в області, як-от R7 Imprecise wording або R30 Closely resembles (можливі дублікати) | quality:R7 |
| Структура, Клас, Атрибути вимоги, Мітка, Зв’язок, Діаграма | Як на сторінці “Вимоги”; атрибути вимоги перелічено без чипа класу | is:tbd, Requirement:"Status=Draft", label:"…" |
Фільтри однієї групи поєднуються через або; різні групи — через і. Діапазони оцінок використовують атрибут: Requirement:"Quality Score>=50". Умови quality: також працюють на сторінці “Вимоги” і в Базі даних.
Подання ▾ застосовує вбудоване подання (Потребує доопрацювання, Ще не перевірено, Застарілі результати, Неоднозначна, Неможливо верифікувати, Можливі дублікати, Ручні оцінки) або одне з ваших збережених подань. Зберегти подання… зберігає поточні фільтри й текст пошуку в цьому браузері для кожного проєкту; Видалити "<name>" з’являється, поки використовується збережене подання. Усі вимоги очищає фільтри. Адреса quality?q=<query> відкриває сторінку з фільтром.
Фільтрування читає збережені результати й не перевіряє знову. На 50,000 вимог зміна фільтра чи пошуку займає значно менше десятої частки секунди.
Критерії та перевірки
Кожен критерій показує одну з трьох позначок:
- ✔ (Так): немає повідомлень.
- ✘ (Ні): щонайменше одне повідомлення.
- –: не перевірено.
Перевірки шукають цілі слова й фрази без урахування регістру. Враховуються лише перелічені форми: “effective” і “effectively” обидва в списку, а “effectiveness” — ні. Слова в лапках також враховуються. Повідомлення нижче — точний показаний текст. Список у квадратних дужках у кінці повідомлення називає знайдені слова.
Однозначна
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| R6 | R6 - Нерозпізнані одиниці; використовуйте стандартні одиниці SI, американські або імперські: [...] | Число, за яким іде слово, що не є відомою одиницею (наприклад, “12 sorties”). Відомі одиниці включають одиниці SI, американські та імперські одиниці та їхні скорочення, %, градуси, °C і °F. |
| R2 | R2 - Використовуйте активний стан: [...] | “shall/must/will/should be”, за яким іде дієприкметник минулого часу (“shall be measured”). |
| R5 | R5 - Використовуйте означені артиклі (“the”) замість: [...] | “a” або “an”. |
| R7 | R7 - Неточне формулювання: [...] | 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. |
| R8 | R8 - Застереження послаблюють вимогу: [...] | if necessary, where possible, as appropriate, as practicable, as far as possible, if practical, as required, as needed, to the extent possible, if possible. |
| R10 | R10 - Непотрібні звороти з інфінітивом: [...] | to be designed to, to be able to, to be capable of, to enable, to allow, be able to, be capable of. |
| R16 | R16 - Уникайте заперечення: [...] | not, n't, never. |
| R17 | R17 - Уникайте похилої риски (“/”). | Похила риска між двома словами, крім km/h, m/s, and/or та його відповідників німецькою, французькою, іспанською, італійською й нідерландською. |
| R24 | R24 - Займенники замість явних іменників: [...] | it, its, they, them, their, he, she, him, her, someone, something, anyone, anything, anybody, somebody, this, these, those. |
| R32 | R32 - Використовуйте “each” замість кванторів загальності: [...] | all, any, both, every, everything, everyone. |
| R34 | R34 - Показники продуктивності, які неможливо виміряти: [...] | 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” не враховується: це назва компонента. |
| R35 | R35 - Нечіткі слова щодо часу: [...] | as, eventually, before, after, until, meanwhile, simultaneous(ly), soon, later, sometimes, occasionally, often, subsequently, previously. |
| — | Замініть заповнювачі TBD/TBR. | TBD, TBR або TBS в описі (великими літерами). |
| — | ШІ: неоднозначна — <причина> | Прийняте зауваження ШІ з Перевірки вимог ШІ. |
| — | Задає максимум (“up to”); якщо мається на увазі мінімум, використовуйте “at least”. | “up to”, за яким іде число цифрами чи словами (“up to 72 hours”, “up to five tonnes”). “Up to date” не враховується. |
Повна
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| — | Немає опису. | Порожній опис. |
| — | Немає назви. | Порожня назва. |
| R9 | R9 - Формулювання відкритого списку: [...] | including but not limited to, etc, and so on, and so forth, such as, among others. |
Одинична
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| R18 | R18 - Напишіть одне речення (знайдено N). | Більше одного речення (також японські й китайські речення, що закінчуються на 。, ! або ?). |
| — | Закінчіть твердження крапкою. | Опис, що не закінчується на “.” (або 。). |
| R19 | R19 - Поєднує дві вимоги; розділіть на окремі вимоги: [...] | and, or, but, however або whereas, що поєднують дві дії чи два обов’язки (“shall log and report each fault”, “… and the operator shall …”), “nor shall”, друга частина після “;”; “and/or” перед другою дією. Див. Дві вимоги в одній (R19). |
| R19 | R19 - “and/or” неоднозначне; вкажіть, чи йдеться про обидва, чи про одне: [and/or] | “and/or” між значеннями або в умові. |
| R19 | R19 - Поєднує два значення; розділіть, якщо кожне верифікується окремо: [...] | and, or, що поєднують два об’єкти чи значення після однієї дії (“measure the temperature and the humidity”). Примітка: Singular залишається Так. |
| R20 | R20 - Містить звороти мети; перенесіть до Rationale: [...] | purpose of, in order to, so that, for the purpose of, so as to. |
| R21 | R21 - Містить дужки; перенесіть текст у дужках до Rationale. | “(” або “[” (також повноширинні дужки). |
Відповідна стандартам
| Повідомлення | Спрацьовує на |
|---|---|
| Використовуйте модальне дієслово: [need, shall, will, should, must] | Жодне з цих слів не з’являється. |
Доречна
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| R31 | R31 - Нав’язує рішення: [...] | using, by means of, utilizing, utilising, implemented in, implemented with, via a, via the, built with, written in. |
Необхідна
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| R30 | R30 - Дуже схожа на: [3.2 Battery Capacity (схожість 81.3%), ...] | Інша вимога в області, опис якої схожий щонайменше на 75% (схожість за парами символів). Зауваження називає до п’яти й рахує решту (“і ще 3”). Безпосередній батьківський елемент вимоги та її дочірні елементи (decomposed by, decomposes) не порівнюються: уточнення часто повторює формулювання батьківського елемента. Сусідні й непов’язані вимоги порівнюються. |
Верифіковна
| Повідомлення | Спрацьовує на |
|---|---|
| Зв’яжіть Test Case або Requirement, що її верифікує. | Вимога не має зв’язку verified by з Requirement чи Test Case. |
| ШІ: неможливо верифікувати в поточному формулюванні — <причина> | Прийняте зауваження ШІ з Перевірки вимог ШІ. |
Здійсненна
| Правило | Повідомлення | Спрацьовує на |
|---|---|---|
| R26 | R26 - Абсолютні терміни, що рідко досяжні: [...] | always, never, 100%, 100 percent, all the time, totally, completely, absolutely, zero defects, forever, continuous, continuously, uninterrupted. |
| — | Потребує судження рецензента | Абсолютних термінів і майже-дублікатів не знайдено; рішення має ухвалити людина. |
Правильна
| Повідомлення | Спрацьовує на |
|---|---|
| Потребує судження рецензента | Кожна текстова перевірка (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 — Ні. |
| Неоднозначне “and/or” | “The log shall record the user ID and/or the badge number.” | Зауваження: укажіть, чи йдеться про обидва, чи про одне. Singular — Ні. |
| Два значення | “The station shall measure the temperature and the humidity.” | Примітка: розділіть, якщо кожне значення верифікується окремо. Singular залишається Так; примітку показано сірим, і вона не знижує оцінку. |
| Немає зауваження | “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).
Перевірити формулювання за допомогою ШІ. ✦ ШІ ▾ → Перевірити формулювання за допомогою ШІ… на сторінці “Якість” (або ✦ Більше ШІ ▸ на одній вимозі) застосовує ті самі правила через налаштований ШІ мовою кожної вимоги. Попередній перегляд перелічує зауваження й необов’язковий переписаний текст цією мовою (не позначений). Застосувати вибране додає зауваження як зауваження ШІ й вилучає примітку (бета-пропозиції залишаються примітками) одним кроком відміни. Редагування тексту очищає їх. Потрібен тариф із ШІ.
Ручні перевизначення
Перевизначайте критерій, коли не згодні з автоматичним результатом, або щоб записати рішення рецензента.
- На сторінці “Якість”: натискайте клітинку критерію, щоб перемикати її по колу: перше клацання задає ручне Так (✔), наступне — ручне Ні (✘), а третє очищає ручне значення, щоб знову вирішувала автоматична перевірка. Ручна клітинка показує позначку ручного значення; її підказка каже “(задано вручну)” і що зробить наступне клацання.
- В інспекторі або Поданні елемента: кожен критерій — список із Так і Ні. Критерій, заданий вручну, також пропонує Автоматично (перевірити знову), що повертає автоматичний результат. Значення, задані вручну, показують “вручну”.
Ручне значення зберігається, коли перевірка запускається знову. Ручне Ні без іншого повідомлення показує “Позначено Ні вручну.”
Перевизначення очищаються у двох випадках:
- Змінюється назва чи опис вимоги. Перевизначення залишаються в історії, і відміна повертає їх.
- Ви вибираєте Більше ▾ → Очистити ручні оцінки. Це також очищає прийняті зауваження ШІ.
Застарілі результати
Коли назва чи опис вимоги змінюється після перевірки, її результати позначаються застарілими:
- Сторінка “Якість” показує “Застаріло — виконати знову” з підказкою “Текст змінився після останньої перевірки. Запустіть перевірку якості знову.”
- Стовпець Оцінка якості документа показує тег Застаріло зі значком годинника (наведіть на нього вказівник, щоб побачити причину).
- Інспектор показує “Якість: застаріла — запустіть знову”.
Увімкніть Автоматично перевіряти знову, коли змінюється текст, щоб уникати застарілих результатів. Тоді Holarch одразу повторно запускає перевірку правил для зміненої вимоги. Налаштування зберігається в цьому браузері.
Перевірка якості з документа
У документі виберіть Перевірити ▾ → Перевірити якість. Якщо вибрано вимогу, пункт показує Перевірити якість цієї вимоги і перевіряє лише її. Якщо вимогу не вибрано, він перевіряє кожну видиму вимогу документа.
Результати відкриваються в діалозі Перевірка якості — <name> з плитками й таблицею. Його кнопки: Експортувати CSV, Експортувати XLSX, Відкрити в Якість і Закрити.
Документ без вимог показує “Цей документ не має Requirements для перевірки. Statements не оцінюються.”
Перевірка вимог ШІ
Використовуйте Перевірку вимог ШІ для першої думки щодо критеріїв, які правило не може вирішити: Correct, Feasible і Necessary. Вона також шукає формулювання, які правила пропускають, за Unambiguous (наприклад, “up to 72 hours”, де, схоже, мається на увазі мінімум, або “accurately” без міри) і Verifiable (жоден тест, аналіз, огляд чи демонстрація не можуть показати виконання вимоги в поточному формулюванні). ШІ отримує зауваження правил і повідомляє лише те, що вони пропускають.
- Виберіть ✦ ШІ ▾ → Перевірити за допомогою ШІ (N вимог)….
Для однієї вимоги виберіть Перевірити за допомогою ШІ (цю вимогу)… в її меню ✦ ШІ ▾ або ✦ Більше ШІ ▸ → ✦ Перевірити за допомогою ШІ… в її контекстному меню.
Claude переглядає вимоги. Їх надсилають групами по 20, разом із до 300 іншими вимогами для перевірки дублікатів. На включеному ШІ перевірка рахує один запит на 100 вимог (з округленням угору); перед перевіркою понад 100 вимог діалог повідомляє, скільки вона використає, наприклад “Цей перегляд використовує 3 з 52 включених запитів ШІ, що залишилися цього місяця (1 запит на 100 вимог).” Перевірка, якій потрібно більше запитів, ніж залишилося, не запускається.
- Перегляньте кожну вимогу в діалозі.
Рядок угорі пояснює, що позначено спочатку: “Позначені елементи застосовуються. Переписані тексти спочатку не позначені, щоб ви спершу їх прочитали. Заблоковані, затверджені вимоги та вимоги в базових лініях спочатку не позначені.”
- Позначте зміни й переписані тексти, які приймаєте.
Рядок над кнопками рахує, що зробить застосування, наприклад “Застосовує 7 значень і 2 переписані тексти до 5 вимог.” Якщо нічого не позначено, він показує “Нічого не вибрано.”, а Застосувати вибране неактивна.
- Натисніть Застосувати вибране.
Позначені елементи застосовуються, і одне натискання “Відмінити” повертає все назад. Сповіщення показує “Застосовано змін ШІ: N”.
Для кожної вимоги діалог показує:
- Висновок Так/Ні і причину для Correct, Feasible, Necessary, Unambiguous і Verifiable.
- Під кожним висновком — прапорець із підписом про те, що змінить застосування, або “без змін” без прапорця, коли збережене значення вже збігається:
- Correct, Feasible і Necessary: “Ні → Так” або “Так → Ні”, коли висновок відрізняється від збереженого значення, “Задати Так” або “Задати Ні”, коли значення немає.
- Unambiguous і Verifiable: “Додає зауваження”, де ШІ знайшов проблему, і “Очищає попереднє зауваження”, де попереднє зауваження ШІ більше не чинне.
- Необов’язковий коментар.
- Де ШІ пропонує переписаний текст, — прапорець Застосувати переписаний текст: з порівнянням слів.
Що позначено спочатку:
- Кожна зміна значення спочатку позначена.
- Переписані тексти спочатку не позначені, щоб ви спершу їх прочитали.
- Затверджені, заблоковані вимоги та вимоги в базових лініях спочатку не позначені й мають позначку.
Позначення переписаного тексту робить неактивними поля Unambiguous і Verifiable цієї вимоги й підписує їх “Перевіряється знову після переписування”: перевірки правил запускаються знову на новому тексті. Зняття позначки з переписаного тексту відновлює поля, як вони були. Correct, Feasible і Necessary однаково застосовуються.
| Кнопка | Дія |
|---|---|
| Вибрати всі зміни значень | Позначає кожну зміну значення, крім затверджених, заблокованих вимог і вимог у базових лініях. |
| Вибрати всі переписані тексти | Позначає кожен переписаний текст, крім позначених застереженням. |
| Нічого не вибирати | Знімає всі позначки. |
Що робить застосування:
- Correct, Feasible і Necessary стають ручними значеннями Так/Ні.
- Ні для Unambiguous чи Verifiable стає зауваженням ШІ: сторінка “Якість” перелічує його разом із зауваженнями правил як “ШІ: неоднозначна — <причина>” або “ШІ: неможливо верифікувати в поточному формулюванні — <причина>”, а критерій показує ✘. Так вилучає попереднє зауваження ШІ.
- Зауваження ШІ очищаються, коли змінюється назва чи опис вимоги (також прийнятим переписаним текстом), і через Більше ▾ → Очистити ручні оцінки.
Що робить Застосувати вибране:
- Висновки стають ручними значеннями з повідомленням “ШІ: <причина>”. Вони зберігаються, коли перевірка запускається знову.
- Переписані тексти замінюють опис і повторно запускають перевірку.
Експорт якості
| Експорт | Вміст |
|---|---|
Експорт ▾ → 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 щодо всіх відповідей). |
| Документ: Видати ▾ → Усі експорти… → Quality findings (Excel) | Таке саме компонування для одного документа зі стовпцями показу документа. |
Затвердження
Використовуйте Потреби та вимоги → Затвердження, щоб бачити все, що очікує рішення. Сторінка відкриває Базу даних із запитом Requirement:"Status=In Review".
Вона має кожну функцію Бази даних:
- Виберіть кілька рядків і скористайтеся панеллю масових дій, щоб задати Status чи мітки разом.
- Експортуйте список.
- Двічі клацніть рядок, щоб відкрити Подання елемента й повну історію.
Поле затвердження
Поле затвердження з’являється в інспекторі й Поданні елемента кожної вимоги. Воно показує:
- Поточний статус як кольоровий чип (Draft, коли статус не задано).
- Останнє записане рішення: “<status> by <name> · <date and time>”, далі “— <note>”, коли є примітка (наприклад, “— Текст змінено після затвердження”), або “Затвердження не записано”.
- Кнопки, що застосовуються до поточного статусу:
| Кнопка | Показується, коли | Дія |
|---|---|---|
| Затвердити | 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 · <date and time> · CR-4”.
Примітка: редагування назви чи опису вимоги зі статусом Approved задає їй In Review з приміткою “Текст змінено після затвердження”. Сповіщення повідомляє “Затверджених вимог переміщено в In Review: N.” Зміна інших атрибутів не відкриває її знову.
Реєстр TBD/TBR
Використовуйте реєстр, щоб відстежувати кожен відкритий елемент, доки його не закрито. Відкрийте Потреби та вимоги → TBD/TBR. З документа виберіть Перевірити ▾ → Реєстр TBD/TBR, щоб відкрити реєстр з областю цього документа.
- Заголовок сторінки: Експортувати XLSX (неактивна, коли реєстр порожній).
- Панель області: Область (Усі вимоги або Документ: <name>).
- Плитки: Відкриті TBD/TBR, Прострочені, Без власника і чипи За документами (“<document>: <count>”), що відкривають кожен документ.
- Відкриті елементи з часом: графік вигорання кількості відкритих елементів. Він відновлюється з історії вимог, з до 60 точками від найстарішої вимоги до сьогодні. Наведіть вказівник на точку, щоб побачити її дату й кількість. Якщо історії замало, він показує “Поки замало історії для графіка вигорання.”
- Стовпці Таблиці:
- Номер і Назва з описом.
- Документ.
- Тип: TBD, TBR або TBS з “атрибут”, “у тексті” або обома.
- Власник: TBD Owner, інакше Owner вимоги, інакше “—”.
- Термін: єдиний термін вимоги, та сама дата, що й Термін у групі Робочий процес інспектора та в Поданні елемента. Це атрибут TBD Due Date, коли він містить дату, інакше термін вимоги. Під минулою датою показує “Прострочено”. Прострочені рядки підфарбовано.
- Вік: дні з моменту відкриття елемента.
- Закрити.
Клацніть рядок правою кнопкою або натисніть на ньому Shift+F10, щоб відкрити те саме меню рядка, що й у Базі даних: запропоновані дії з причинами, ✦ Більше ШІ ▸, Відкрити, Перейменувати…, Дублювати, Додати дочірній…, Status ▸, Пріоритет ▸, Зв’язати з ▸, Додати до документа ▸, Показати на діаграмі ▸, Копіювати посилання, Копіювати номер і Видалити…. В інших контекстних меню вимога з відкритим 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. Задання першого методу чи рівня вимоги нічого не позначає: це планує верифікацію й не змінює нічого, що переглядали.
Інший кінець кожного зв’язку — елемент для перегляду: дочірня вимога, функція чи актив, що її задовольняє, тестовий випадок, що її верифікує, тощо. Подальші зміни тієї самої вимоги додаються до списку змінених полів тієї самої позначки.
Де показуються зв’язки для перевірки
- Сторінка Зв’язки для перевірки: один рядок на кожен зв’язок для перевірки.
- Документи й База даних: значок ⚠ Перевірити у рядку елемента (“Елемент на іншому кінці змінився після останнього перегляду цього зв’язку. Перевірте, що зв’язок досі чинний, потім позначте його перевіреним. Натисніть, щоб переглянути.”).
- Інспектор і Подання елемента: банер “⚠ Перевірити: <requirement> змінилася після останнього перегляду цього зв’язку. Перевірте, що зв’язок досі чинний, потім позначте його перевіреним.” Його кнопка Перевірити… відкриває для цього елемента діалог Зв’язки для перевірки — <item> з Відкрити Зв’язки для перевірки і Закрити.
- Розділ Трасування інспектора: ⚠ біля кожного зв’язку для перевірки зі зміненими полями й датою в підказці.
- RVTM: ⚠ після вимоги зі зв’язком для перевірки на будь-якому кінці (вона змінилася або змінився елемент вище за ланцюгом); натисніть його, щоб переглянути ці зв’язки. ⚠ після тестового випадку у Verified by позначає цей зв’язок верифікації.
Сторінка “Зв’язки для перевірки”
Сторінка пояснює правило вгорі й показує таблицю:
| Стовпець | Вміст |
|---|---|
| (прапорець) | Вибрати для Позначити вибрані перевіреними…. Прапорець у заголовку вибирає всі. |
| Змінено | Вимога, що змінилася. |
| Зміна | Поля, що змінилися, наприклад “Description” або “Priority, Verification Level”. |
| Коли / Хто | Дата й час зміни та хто її вніс. |
| Зв’язок | Тип зв’язку, прочитаний від зміненої вимоги (наприклад, “satisfied by”). |
| Елемент для перегляду | Елемент на іншому кінці зв’язку. |
| (дії) | Порівняння і Позначити перевіреним…. |
Клацніть рядок правою кнопкою або натисніть на ньому Shift+F10, щоб відкрити меню рядка елемента, як у Базі даних: запропоновані дії, ✦ Більше ШІ ▸, Відкрити, Перейменувати…, Дублювати, Додати дочірній…, Status ▸, Пріоритет ▸, Зв’язати з ▸, Додати до документа ▸, Показати на діаграмі ▸, Копіювати посилання, Копіювати номер і Видалити…. В інших контекстних меню (База даних, документи) елемент зі зв’язком для перевірки починається з Переглянути зв’язок…, що відкриває перегляд для нього.
Порівняння відкриває Зміна — <requirement> з порівнянням слів назви й опису. Коли змінилися лише атрибути, воно показує “Змінилися лише атрибути: <fields>. Відкрийте історію сутності, щоб побачити подробиці.” Історія… відкриває історію вимоги.
Щоб позначити зв’язки перевіреними:
- Натисніть Позначити перевіреним… у рядку, Позначити вибрані перевіреними… для позначених рядків або Позначити всі перевіреними (N)….
Відкривається Позначити перевіреними зв’язки (N): “Підтвердьте, що пов’язані елементи досі чинні після зміни. До кожного пов’язаного елемента додається коментар.”
- Введіть необов’язковий коментар, наприклад “Дочірня вимога досі чинна; змін не потрібно.”
- Натисніть Позначити перевіреним.
Сповіщення показує “Позначено перевіреними зв’язків: N.”
Позначити вибрані перевіреними…, коли нічого не вибрано, показує “Спершу виберіть зв’язки, щоб позначити їх перевіреними.”
Позначення зв’язку перевіреним записує перегляд на зв’язку: хто, коли, коментар і поля. Якщо ви написали коментар, Holarch також додає “Зв’язок перевірено (<requirement> змінено: <fields>): <comment>” до коментарів кожного елемента. Відміна скасовує це.
Якщо зв’язків для перевірки немає, сторінка показує “Немає зв’язків для перевірки. Зв’язок потребує перегляду, коли елемент на його іншому кінці змінюється після останнього перегляду зв’язку.”
Базові лінії й порівняння версій
Базові лінії документа
Створюйте й використовуйте базові лінії документа через Версія ▾ в основному написі документа. Список містить:
- Поточна версія: робочий документ.
- Кожну базову лінію цього документа, від найновішої, з датою.
- У розділі Базові лінії проєкту — кожну базову лінію проєкту.
- Зберегти базову лінію… і Порівняти версії… (неактивна, доки документ не має базової лінії: “Спершу збережіть базову лінію”).
Зберегти базову лінію… відкриває Зберегти базову лінію:
- Назва * (обов’язково).
- Затвердження: рядки з Ім’ям, Роллю й Заявою та + Додати затверджувача. Перший рядок заповнено вашим іменем. “Немає затверджувачів.”, коли порожньо.
- Примітка “Базова лінія зберігає цю версію документа (його елементи, їхні атрибути й зв’язки), щоб пізніше переглядати, порівнювати й відновлювати її. Записи про затвердження датуються зараз, і згодом їх не можна редагувати.”
Виберіть базову лінію у Версія ▾, щоб переглянути її. Документ стає доступним лише для читання з банером “Базова лінія “<name>”, лише для читання, збережено <date>” і списком затверджень. З’являються такі кнопки:
| Кнопка | Дія |
|---|---|
| Назад до поточної | Повертає до робочого документа. |
| Редагування | Редагувати базову лінію: перейменувати її й додати записи про затвердження. Затвердження (заблоковано) перелічує наявні записи, які не можна змінити; нові записи “датуються зараз і додаються до списку”. Лише базові лінії документа. |
| Порівняти з поточною | Відкриває Порівняти версії від цієї базової лінії. Лише базові лінії документа. |
| Відновити базову лінію | Базова лінія документа: “Перезаписати сутності, порядок і структуру цього документа базовою лінією “<name>”? Сутності, додані відтоді, вилучаються з документа (не видаляються). Відміна доступна.” Базова лінія проєкту: Замінити проєкт базовою лінією, “Замінити весь проєкт базовою лінією проєкту “<name>”? Відміна доступна.” |
| Видалити | “Видалити базову лінію “<name>”?” |
У робочому документі кожен рядок має смугу зміни: новий після базової лінії, змінений після базової лінії або без змін. Порівняння ведеться з останньою базовою лінією документа або з останньою базовою лінією проєкту, коли документ не має власної.
Порівняти версії
Використовуйте звіт про зміни, щоб точно побачити, що змінилося після рецензування.
- Натисніть Версія ▾ → Порівняти версії… або Порівняти з поточною в банері базової лінії.
Відкривається Порівняти версії.
- Виберіть Від: базову лінію.
- Виберіть До: пізнішу базову лінію або Поточна версія.
Таблиця перелічує Номер, Назва, Тип зміни, Поле і Зміна (порівняння слів для зміненого тексту).
Типи змін:
| Тип зміни | Значення |
|---|---|
| Додано / Вилучено | Сутність увійшла до документа або залишила його. |
| Змінено | Змінилося поле: Name, Number, Description, Class, Image або будь-який атрибут (поле названо). |
| Мітку додано / Мітку вилучено | Мітку додано або вилучено. |
| Зв’язок додано / Зв’язок вилучено | Зв’язок, що стосується документа, додано або вилучено. |
| Атрибут зв’язку | Атрибути зв’язку змінилися. |
Зміни (Excel) записує “<document> (Changes).xlsx” з Number, Name, Class, Change Type, Field, Old Value і New Value. Правки (Word) записує те саме порівняння як відстежувані зміни Word.
Видати ▾ → Зміни (Excel)… документа (також в Усі експорти…) експортує той самий звіт з Від і До. Якщо базової лінії немає, експорт не вдається з повідомленням “Цей документ не має базової лінії. Спершу збережіть її.”
Документ (Word) заповнює таблиці Revision History і Approvals вихідного файлу Word з базових ліній документа.
Сторінка “Базові лінії та версії”
Використовуйте Контроль і рецензування → Базові лінії та версії, щоб керувати кожною базовою лінією проєкту. Базові лінії проєкту містять кожну сутність; базові лінії документа містять один документ і створюються через Версія ▾ → Зберегти базову лінію… документа. Заголовок сторінки має Відновити попередню версію…, що повертає попереднє автоматичне збереження всього проєкту, і + Зберегти базову лінію….
Щоб створити базову лінію проєкту:
- Натисніть + Зберегти базову лінію… у заголовку сторінки.
Діалог Зберегти базову лінію проєкту показує поточну кількість сутностей і зв’язків. Типова назва — “Baseline <n>”; заповнювач показує “Назва, наприклад “SRR””.
- Введіть назву, потім натисніть Enter або Зберегти базову лінію. Порожня назва відхиляється (“Введіть назву.”).
Сповіщення показує “Базову лінію збережено”.
Картки сторінки:
- Картка Базові лінії: поточні кількості (“Поточна: <n> елементів, <n> зв’язків”) і фільтр: Усі базові лінії, Базові лінії всього проєкту або Документ: <name>. Стовпці:
- Назва.
- Документ: посилання для перегляду документа в цій базовій лінії або “Проєкт”.
- Створено.
- Затвердження: “✔” та імена затверджувачів. Наведіть на них вказівник, щоб побачити роль, дату й заяву. “by <name>” називає автора.
- Сутності і Зв’язки.
- Порівняти: задає цю базову лінію як Від, а поточну робочу копію як До.
- ⋯ (Інші дії):
- Перейменувати…: Перейменувати базову лінію.
- Експортувати (JSON): завантажує “<name>.json” (формат
holarch-baseline, зі знімком і затвердженнями). - Відновити базову лінію… (базова лінія проєкту): “Замінити всі поточні сутності й зв’язки базовою лінією “<name>”? Відміна доступна (⌘Z / Ctrl+Z).” Сповіщення: “Відновлено “<name>””.
- Повернути документ… (базова лінія документа): “Відновити документ “<doc>” до базової лінії “<name>”? Змінюються лише сутності й структура цього документа. Відміна доступна.” Неактивна, коли документ видалено.
- Видалити…. У хмарному сервісі лише власники проєкту перейменовують або видаляють базову лінію; для інших ці пункти неактивні з поясненням причини.
- Осиротілі базові лінії (показуються за потреби): “Базових ліній видалених документів: 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, текст) | Automatic, UTF-8, ISO-8859-1 / Windows-1252, Shift_JIS, Big5, UTF-16 | Як читаються байти файлу. Зміна повторно читає файл. |
| Аркуш (робочі книги) | “<name> (N рядків)” | Аркуш для імпорту. Перший аркуш із даними вибрано заздалегідь. |
- Звичайний текст: поле зберігає імпортований вміст для редагування. Відредагуйте його й натисніть Повторити аналіз.
- Рядок стану показує “Проаналізовано “<file>”: N рядків, M стовпців.” (плюс “(аркуш “<name>”)” і, для 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 ID | ID рядка / ID батьківського рядка |
Новий атрибут створює атрибут, названий за стовпцем, у кожному імпортованому класі. Його тип залежить від значень:
- Число, коли кожне значення — число.
- Список варіантів, коли є мало коротких різних значень.
- Довгий текст — для значень понад 120 символів.
- Інакше текст.
Критерії якості, обчислювані атрибути й атрибути файлів не можна зіставити.
Під стовпцями:
| Параметр | Значення | Дія |
|---|---|---|
| Клас для рядків без класу | Будь-який клас; типово Requirement | Клас рядків без значення в стовпці Class і без відповідного правила класу. |
| Правила класів | Опис містить слово чи фразу → клас | + Правило додає правило, × вилучає його. Перше відповідне правило застосовується до рядків без значення Class. |
| Зіставляти наявні сутності за | Global ID, Name, Number | Рядки, що відповідають наявній сутності, оновлюють її замість створення копії. Збіги за Name і Number також вимагають того самого класу. |
| Зіставляти пов’язані сутності за | Global ID, Name, Number | Як значення в стовпцях зв’язків знаходять свої цілі. |
| Формат дати в стовпцях дат (CSV) | Automatic, 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, Attribute, New attribute або Skip.
- Заголовки на кшталт 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 під поточним заголовком.
- Інший текст приєднується до опису попереднього елемента.
- Із шаблоном нумерації (визначеним із тексту або введеним) рівні визначає шаблон.
Оновлення вимог з електронної таблиці
Скористайтеся цим, щоб змінити багато вимог одразу в електронній таблиці.
- У Базі даних (або на сторінці “Вимоги”) натисніть Експортувати… і виберіть Таблиця (CSV).
- Позначте атрибути для редагування. У розділі Включити позначте ID, потім натисніть Експортувати.
- Відредагуйте значення в електронній таблиці. Не змінюйте стовпець ID.
- Імпортуйте файл. У Відповідність перевірте, що стовпець ID зіставлено з Глобальний ID, і задайте Зіставляти наявні сутності за значення Глобальний ID.
- У Перегляд зніміть позначку Створити документ….
Зіставлені рядки враховуються як Оновлені елементи з переліком кожного зміненого поля.
- Натисніть Імпортувати N елементів.
Значення I_… з файлу, експортованого до цього випуску, не збігається; використовуйте стовпець ID. Щодо кожного кроку й параметра див. Імпорт і експорт.
Що записує оновлення:
- Лише зіставлені стовпці. Якщо стовпця Description немає, кожен наявний опис зберігається.
- Мітки з файлу додаються до наявних міток.
- Без стовпця Class рядок, зіставлений за Глобальним ID, зберігає клас своєї сутності.
Повідомлення імпорту
| Повідомлення | Значення та виправлення |
|---|---|
| Жоден стовпець не зіставлено з Name або Number. Зіставте один із них. | Зіставте щонайменше один стовпець із Name або Number. |
| Рядок N: невідомий клас “X”, використано <class>. | Значення Class не відповідає жодному класу. Виправте значення або зіставте стовпець із Пропустити. |
| Рядок N: невідому мітку “X” проігноровано. | Спершу створіть мітку в схемі або виправте значення. |
| Рядок N: “<attribute>” не застосовується до класу <class>. | Клас рядка не має такого атрибута. |
| Рядок N: “<value>” не є дійсним значенням типу <type> для “<attribute>”. | Значення неможливо прочитати як число, дату, варіант тощо. Перевірте параметр формату дати. |
| Рядок N: Name довше за 255 символів, його скорочено. / Рядок N: Number довше за 255 символів, його скорочено. | Назви й номери обмежено 255 символами. |
| Повторюваний номер X (рядки A і B). | Два рядки мають однаковий номер; ієрархія може приєднати дочірні елементи до першого. |
| Рядок N: немає батьківського номера P для X; приєднано до Q. / …; імпортовано на верхньому рівні. | Безпосереднього батьківського номера немає у файлі. |
| Рядок N: батьківський номер P не знайдено. / Рядок N: батьківський елемент P не знайдено. | Parent Number або Parent Row ID посилається на рядок, якого немає у файлі. |
| Рядок N: ціль “X” зв’язку “<relationship>” не знайдено. | Стовпець зв’язку називає сутність, якої не існує. Перевірте Зіставляти пов’язані сутності за. |
| Рядок N: схема не дозволяє “<relationship>” від A до B (однаково створено). | Зв’язок створено, хоча схема його не перелічує. |
| Схема не дозволяє зв’язок “X” між A і B; пропущено. | Відношення ReqIF чи XMI не вдалося створити навіть як traced to. |
| Зображення X: зображення .ext не підтримуються, їх пропущено. Збережіть зображення у Word як PNG або JPEG, щоб зберегти його. | Зображення Word у непідтримуваному форматі. |
| Зображення X (розмір) перевищує обмеження для вкладень <limit>, його пропущено. | Зображення більше за обмеження для одного файлу. |
| Рядків даних не знайдено. | Файл або аркуш містить лише заголовок або порожній. |
| Не вдалося прочитати файл: файли Excel 97-2003 (.xls) не підтримуються. У Excel збережіть файл як .xlsx або .csv, потім імпортуйте його знову | Перетворіть файл. |
| Не вдалося прочитати файл: XML з оголошенням DOCTYPE або ENTITY не приймається. Збережіть файл без нього й імпортуйте знову | Вилучіть оголошення з файлу ReqIF чи XML. |
| Не вдалося прочитати файл: недійсний XML | Файл ReqIF не є правильно сформованим XML. |
| Імпорт не вдався: <reason> | Імпорт зупинився; нічого не змінено. |
Клавіатурні скорочення для вимог
| Клавіші | Де | Дія |
|---|---|---|
| Enter | Швидке введення в документі | Додати введену вимогу. |
| ⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+Enter | Документ, елемент вибрано | Додати сусідній / дочірній елемент. |
| Enter або Space | Рядки “Якість”, “TBD/TBR” і “Зв’язки для перевірки” | Показати вимогу рядка або елемент для перегляду в інспекторі. |
| ↑ / ↓ | Ті самі рядки, рядок у фокусі | Перейти до попереднього чи наступного рядка. |
| ⌘ / Ctrl-клацання, ⇧ / Shift-клацання, ⌘ / Ctrl+⇧ / Shift-клацання | Рядки “Якість”, “TBD/TBR” і “Зв’язки для перевірки”; рядки Бази даних; елементи документа | Перемкнути рядок, вибрати діапазон від останнього клацнутого рядка, додати цей діапазон. |
| ⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓ | Ті самі рядки, рядок у фокусі | Вибрати кожен показаний рядок; розширити виділення від рядка у фокусі. |
| Клацання правою кнопкою, Shift+F10 або клавіша Menu | Рядки “Вимоги”, “Якість”, “TBD/TBR” і “Зв’язки для перевірки”; елементи документа й записи структури | Відкрити меню рядка: спершу запропоновані дії з причинами й ✦ Більше ШІ ▸, потім команди елемента. |
| Esc | Якість, TBD/TBR, Зв’язки для перевірки, RVTM | Зняти вибір рядка. |
| Enter | Поле назви на сторінці “Базові лінії та версії” | Створити базову лінію проєкту. |
| ⌘Z / Ctrl+Z | Будь-де | Відмінити останню зміну, зокрема цілий імпорт, позначення зв’язків перевіреними чи зміну статусу. |
Щодо кожного клавіатурного скорочення застосунку див. Клавіатурні скорочення.
Налаштування
| Налаштування | Де | За замовчуванням | Область |
|---|---|---|---|
| Автоматично перевіряти знову, коли змінюється текст | Панель області сторінки “Якість” | Вимкнено | Цей браузер |
| Групи інспектора згорнуті чи відкриті (Якість та інші) | Натисніть заголовок групи в інспекторі або Згорнути все / Розгорнути все в кінці його посилань | Якість згорнута, решта відкрита | Цей браузер, для кожного класу |
| Ваше ім’я в затвердженнях, рішеннях і коментарях | Ім’я вашого облікового запису | — | Обліковий запис |
| Статус простежуваності (точки на вимогах) | Документ: Вигляд ▾ | На чому | Документ |
Повідомлення
| Повідомлення | Де | Значення |
|---|---|---|
| Перевірено вимог: N | Якість | Перевірку виконано для області. |
| У цій області немає вимог. | Якість | Область не має вимог. |
| Цей документ не має Requirements для перевірки. Statements не оцінюються. | Перевірка якості документа | Змініть елементи на Requirement або перевірте інший документ. |
| Застаріло — виконати знову / Застаріло / Якість: застаріла — запустіть знову | Якість, документи, інспектор | Текст змінився після останньої перевірки. |
| Потребує судження рецензента | Якість (Correct, Feasible) | Рішення має ухвалити людина; натисніть ✘, щоб позначити Так. |
| Позначено Ні вручну. | Якість | Рецензент задав критерію значення Ні. |
| Затверджених вимог переміщено в In Review: N; зв’язків позначено для перегляду: N. | Після редагування | Редагування знову відкрило затвердження й позначило зв’язки для перевірки. |
| Затверджено / Відхилено / Переміщено в In Review | Поле затвердження | Рішення записано. |
| Позначено перевіреними зв’язків: N. | Зв’язки для перевірки | Перегляди записано. |
| Спершу виберіть зв’язки, щоб позначити їх перевіреними. | Зв’язки для перевірки | Позначте рядки перед Позначити вибрані перевіреними…. |
| Закрито / Атрибут закрито; текст досі містить TBD. | TBD/TBR | Атрибуту задано значення None. |
| Текст досі містить TBD. Відредагуйте текст, щоб закрити його. | TBD/TBR | Показується під час закриття елемента лише з тексту. |
| Базову лінію збережено | Документи, Базові лінії та версії | Знімок збережено. |
| Цей документ не має базової лінії. Спершу збережіть її. | Порівняти з поточною, звіти про зміни | Документ не має базової лінії. |
| Повернуто до “<name>” / Відновлено “<name>” | Базові лінії | Документ або проєкт повернуто до попереднього стану; відміна доступна. |
| Немає вимог для перегляду. Спершу виберіть або відкрийте вимоги. | Перевірка вимог ШІ | В області немає вимог. |
Обмеження
- Перевірка якості: кожна вимога в області порівнюється з іншими на дублікати (поріг схожості 75%).
- Перевірка вимог ШІ: 20 вимог на запит ШІ, з до 300 іншими вимогами як контекстом.
- Порівняння для перегляду зв’язку зберігає перші 500 символів старої назви й 4,000 символів старого опису.
- Графік вигорання 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).
Пов’язане
- Документи: писати й структурувати специфікації, звіти й вихідні файли DOCX.
- Простежуваність: зв’язки, Матриця простежуваності, покриття й вплив.
- Модель і база даних: запити, стовпці й масове редагування.
- Розширення схеми: додавання атрибутів вимог, варіантів і міток.
- Імпорт і експорт: кожен формат файлів.
- Довідка: Вимоги, статус і затвердження, Якість вимог, Реєстр TBD/TBR, Зв’язки для перевірки, Затвердження, Імпорт, Базові лінії та версії, RVTM.