Посібник · Вимоги
Як писати якісні системні вимоги: приклади й контрольний список
Слухати цей посібник 26 хв
Якісна вимога каже одну річ, яку система повинна робити чи якою бути, словами, які два інженери прочитають однаково, зі значенням, яке може перевірити тест чи аналіз. Цей посібник охоплює потреби проти вимог, частини формулювання вимоги, характеристики якості в ISO/IEC/IEEE 29148 і INCOSE Guide to Writing Requirements, контрольний список із прикладами «до» і «після», метод верифікації й критерії приймання, значення TBD і TBR та типи вимог — усе на прикладі однієї специфікації CubeSat.
На цій сторінці
- Чому формулювання вимоги має значення
- Потреби зацікавлених сторін проти вимог
- Анатомія вимоги
- Характеристики якості доброї вимоги
- Контрольний список: правила з прикладами «до» і «після»
- Записуйте метод верифікації й критерії приймання разом із вимогою
- Робота зі значеннями TBD і TBR
- Типи вимог
- Практичний приклад: рецензування специфікації EO-1
- Типові помилки
- Спробуйте в Holarch
- Завантажте контрольний список
- Запитання про написання вимог
- Куди далі
Чому формулювання вимоги має значення
Вимога — це контракт між тими, хто замовляє систему, і тими, хто її будує. Її читає все, що йде далі: конструктор розраховує під неї компонент, інженер з випробувань пише за нею критерій проходження, рада зі змін зважує щодо неї зміну, а замовник за нею приймає систему. Кожен із них читає те саме речення, зазвичай без автора поруч. Якщо речення можна прочитати двома способами, так і станеться, а різниця виявиться пізно: на тесті, який «проходить» за критерієм, якого ніхто не погоджував, або на прийманні, коли замовник мав на увазі інше.
Погане формулювання ламає й решту моделі. Вимогу без значення неможливо розподілити на компонент, бо ніхто не скаже, чи компонент їй відповідає. Її неможливо верифікувати, тож вона з’являється як прогалина в покритті в простежуваності і матриці верифікації. А коли вона змінюється, ніхто не може сказати, чи пов’язаний проєкт досі чинний. Якісне написання вимог — найдешевша робота з якості в проєкті: година над реченням на початку заощаджує кампанію випробувань наприкінці.
Посібник використовує один наскрізний приклад — EO-1, вигаданий 6U CubeSat, що знімає сільськогосподарські угіддя в чотирьох спектральних смугах. Його специфікація, SRS-001 EO-1 System Requirements Specification, містить 32 вимоги, більшість із них добротні, а три навмисно слабкі. Це та сама модель, що й у наскрізному прикладі проєкту MBSE. Потреби зацікавлених сторін N1–N3, наведені тут, — ті, які посібник із простежуваності додає до моделі.
Потреби зацікавлених сторін проти вимог
Написання вимог починається на крок раніше — з потреб. Потреба зацікавленої сторони — це те, чого очікує користувач, оператор, замовник чи регулятор, у їхніх власних термінах. Вимога — це інженерне формулювання, щодо якого систему проєктують і верифікують. ISO/IEC/IEEE 15288 розділяє їх в окремі технічні процеси: визначення потреб і вимог зацікавлених сторін (6.4.2) і визначення системних вимог (6.4.3). INCOSE Needs and Requirements Manual робить той самий поділ і розглядає потреби як самостійні елементи, а не як чорнові варіанти вимог.
| Приклад з EO-1 | Чим перевіряється | |
|---|---|---|
| Потреба (N2 Twice-Weekly Revisit) | Фермерським клієнтам потрібні свіжі знімки їхніх полів щонайменше двічі на тиждень у вегетаційний сезон. | Валідація: чи отримують клієнти від поставленої системи те, що їм потрібно? |
| Вимога (1.6 Revisit Time) | Місія повинна повторно знімати кожен цільовий регіон протягом 72 годин. | Верифікація: чи відповідає система формулюванню — за тестом, аналізом, оглядом чи демонстрацією? |
Різницю видно з того, як перевіряється кожна з них. Вимогу верифікують: систему вимірюють щодо формулювання. Потребу валідують: хтось підтверджує, що система під час передбаченого використання робить те, чого хотіла зацікавлена сторона. Система може пройти кожну верифікацію й усе одно не пройти валідацію, якщо вимоги не влучили в суть; посібник про верифікацію і валідацію описує цей розрив. Для написання практичний висновок простий: спершу запишіть потребу, потім напишіть вимоги, які задовольнили б її в разі виконання, і пов’яжіть кожну вимогу з потребою, на яку вона відповідає.
Переклад рідко буває один до одного. N2 стає 1.6 Revisit Time, яку потім декомпонують на 1.6.1 Ground Track Repeat (3 доби) і 1.6.2 Off-Nadir Imaging (25 градусів). Деякі вимоги не відповідають безпосередньо жодній потребі: 3.1 Orbit Average Power походить від 1.5 Daily Collection Volume, бо навантаження від знімання визначає потужність, яку мають забезпечити панелі. Жоден клієнт не просив 30 W, але знімання, про яке вони просили, без цього неможливе.
Анатомія вимоги
Вимога — це більше, ніж її речення. Речення несе зобов’язання; набір атрибутів довкола нього несе причини, план доведення й облік. Обидві половини — частина її написання.
Формулювання
Більшість добрих формулювань вимог вкладаються в один шаблон. ISO/IEC/IEEE 29148 (5.2.4) описує його як суб’єкт, дію, об’єкт і обмеження на дію з необов’язковою умовою попереду; INCOSE Guide to Writing Requirements рекомендує той самий порядок і погоджені шаблони для кожного виду вимог.
| Частина | Що вона каже | EO-1 4.3 Fault Detection |
|---|---|---|
| Умова (необов’язкова) | Коли, у якому режимі чи стані застосовується вимога | «…of undervoltage detection» (подія, що спрацьовує) |
| Суб’єкт | Система чи елемент, який має відповідати, точно названий | «The C&DH» |
| Модальне дієслово | Сила зобов’язання | «shall» |
| Дія | Що суб’єкт робить чи чим є, як дієслово в активному стані | «enter» |
| Об’єкт | До чого застосовується дія | «safe mode» |
| Характеристика чи обмеження | Вимірюване значення з одиницею та напрямком межі | «within 10 seconds» |
Разом: «The C&DH shall enter safe mode within 10 seconds of undervoltage detection.» Порядок може змінюватися («When undervoltage is detected, the C&DH shall…» ставить умову першою, як у шаблонах EARS, якими користуються багато команд), але кожна частина має бути присутня або свідомо відсутня.
Найбільшу вагу несуть три слова. Shall позначає обов’язкову вимогу; will констатує факт чи намір щодо чогось поза системою; should формулює мету, яку не верифікують. Хоч би яку конвенцію використовував проєкт, визначте її один раз у специфікації й дотримуйтеся її. EO-1 1.1 Reference Orbit («The mission assumes a 500 km sun-synchronous orbit…») правильно записано як припущення, а не вимогу: це контекст для вимог, які від нього залежать, і модель зберігає його як твердження, яке не оцінюється й не верифікується.
Атрибути
Ось 3.1 Orbit Average Power у тому вигляді, як її фіксує модель EO-1, після зміни з 28 W на 30 W після PDR:
| Атрибут | 3.1 Orbit Average Power | Навіщо він |
|---|---|---|
| Ідентифікатор і назва | 3.1 Orbit Average Power | Стабільна прив’язка для зв’язків, рецензувань і запитів на зміну |
| Формулювання | Сонячні панелі повинні генерувати щонайменше 30 W середньоорбітальної потужності наприкінці строку служби. | Саме зобов’язання |
| Обґрунтування | Середньоорбітальне навантаження зросло до 26 W після PDR; 30 W зберігають запас 15%. | Дає змогу пізнішому читачеві оцінити зміну без автора |
| Джерело й батьківська вимога | Похідна (системний аналіз); походить від 1.5 Daily Collection Volume | Зворотна простежуваність: чому вимога існує |
| Метод і рівень верифікації | Тест, на рівні підсистеми | План доведення, визначений під час написання |
| Критерії успіху | Середньоорбітальна потужність наприкінці строку служби, спрогнозована з виміряної пікової потужності. | Який результат вважається виконанням |
| Власник, пріоритет, критичність | Power Engineer; High; High | Хто за неї відповідає і наскільки вона важлива |
| Статус | In Review (була Approved; її текст змінився після затвердження) | На якому етапі процесу погодження вона перебуває |
| TBD/TBR | Немає | Чи значення ще відкрите |
ISO/IEC/IEEE 29148 (5.2.8) перелічує атрибути такого роду, а посібник INCOSE додає інші; проєкт вибирає ті, які справді підтримуватиме. Обґрунтування найчастіше пропускають і найчастіше потім його бракує. Без «навантаження 26 W, запас 15%» наступна людина, яка побачить 3.1, не зможе сказати, чи 30 W — жорстка фізична межа, число замовника чи вибір запасу, а отже, не зможе сказати, що для неї означає зміна навантаження.
Характеристики якості доброї вимоги
Правила стилю легше застосовувати, коли знаєш, що вони захищають. ISO/IEC/IEEE 29148 (5.2.5) називає дев’ять характеристик окремої вимоги, а INCOSE Guide to Writing Requirements використовує ті самі дев’ять як C1–C9, кожну з коротким визначенням і правилами, що її підтримують. Таблиця подає кожну як запитання, яке може поставити рецензент.
| Характеристика | Запитання | Приклад з EO-1 |
|---|---|---|
| Необхідна | Якби її видалили, чи втратилося б щось потрібне зацікавленим сторонам? Чи не є вона дублікатом? | 3.1 необхідна: без неї ніщо не визначає розміри панелей під навантаження від знімання. |
| Доречна | Чи написана вона на правильному рівні, не фіксуючи проєктного рішення, яке має ухвалити нижчий рівень? | 3.1 задає рівень потужності для панелей, а не тип елементів чи кількість панелей. |
| Однозначна | Чи можна прочитати її лише одним способом? | 6.4 «user friendly» не проходить: два рецензенти не погодяться, чи її виконано. |
| Повна | Чи каже вона все потрібне, без пропущеної умови чи значення? | 3.5 «warm enough (TBD)» не проходить: значення бракує. |
| Одинична | Чи формулює вона одне зобов’язання? | 2.5 не проходить: вона вимагає відновитися й відновити знімання, поєднані через «and». |
| Здійсненна | Чи можна її виконати в межах відомих обмежень технологій, вартості й графіка? | 3.1 на 30 W під питанням: спроєктовані панелі дають близько 28 W у середньому за орбіту. |
| Верифіковна | Чи може тест, аналіз, огляд чи демонстрація показати, що її виконано? | 2.5 «quickly» не проходить; «within 6 hours» проходить. |
| Правильна | Чи формулює вона справжню потребу свого джерела з правильним значенням? | 1.2 просторова роздільність 4,5 m правильно виражає N3 карти на рівні поля, із запасом. |
| Відповідна стандартам | Чи дотримується вона погоджених у проєкті шаблонів і словника? | Кожна вимога EO-1 використовує «shall», названий суб’єкт і одиниці SI. |
Набір вимог має власні характеристики, яких не може показати жодне окреме формулювання. ISO/IEC/IEEE 29148 (5.2.6) визначає набір як повний, узгоджений, здійсненний у цілому, зрозумілий і придатний до валідації; посібник INCOSE додає правильний як C15 і нумерує характеристики набору C10–C15.
- Повний: набір покриває потреби. EO-1 визначає, що відбувається при зниженій напрузі (4.3), але її єдина вимога до виходу з безпечного режиму — 2.5, яку в нинішньому формулюванні неможливо верифікувати, тож відновлення фактично не специфіковано.
- Узгоджений: жодні дві вимоги не суперечать одна одній, а терміни й одиниці вживаються однаково. 1.5 вимагає 3,2 GB даних зображень на добу, а 5.4 — 3 GB, отриманих на Землі; вони узгоджуються лише тому, що обґрунтування 5.4 каже «after compression». Без обґрунтування вони схожі на суперечність.
- Здійсненний: вимоги можна виконати разом. Кожна вимога до живлення може бути здійсненною окремо, тоді як 30 W у середньому за орбіту, площа панелей і бюджет маси разом — можуть і ні.
- Зрозумілий: читач може зрозуміти, чого очікують від системи і як вимоги пов’язані між собою, а це залежить від структури, нумерації й простежуваності не менше, ніж від формулювань.
- Придатний до валідації: можна показати, що набір веде до системи, яка задовольняє потреби, і тому кожна вимога верхнього рівня пов’язана з потребою.
Контрольний список: правила з прикладами «до» і «після»
Характеристики стають придатними до використання завдяки конкретним правилам написання. INCOSE Guide to Writing Requirements нумерує їх (R1, R2 і так далі); NASA Systems Engineering Handbook (додаток C) має коротший контрольний список у тому самому дусі. Таблиця збирає правила, що на практиці виявляють більшість проблем, із прикладом зі специфікації EO-1 для кожного. «До» — текст у тому вигляді, як він є в демопроєкті; «Після» — переписаний варіант. Значення, позначені як ілюстративні, показують форму, а не результати аналізів EO-1.
| Правило | Запитання | До (EO-1) | Після |
|---|---|---|---|
| Одне зобов’язання на формулювання | Рівно одне «shall», жодних «and», «or», «and/or», що поєднують дві вимоги? | 2.5: «The spacecraft should recover from safe mode quickly and resume imaging as appropriate» | «The spacecraft shall resume imaging within 6 hours of a safe mode entry.» Подальші важливі кроки відновлення отримують власні вимоги. |
| Обов’язкове формулювання | «Shall» для обов’язкової вимоги, а не «should», «will» чи «may»? | 2.5: «should recover» | «shall resume» |
| Вимірюване значення з одиницею | Чи має кожне слово про характеристику число й одиницю? | 2.5: «quickly» | «within 6 hours of a safe mode entry» |
| Зазначено напрямок межі | Чи зрозуміло, мінімум це чи максимум? | 1.6.2: «image targets up to 25 degrees off nadir» | «image targets at off-nadir angles from 0 to 25 degrees» (діапазон можливостей, а не обмеження наведення) |
| Без лазівок | Чи залишено щось на розсуд постачальника («as appropriate», «if possible», «where practical»)? | 2.5: «as appropriate» | Вилучено; зазначено умову, яка має значення |
| Без розмитих чи суб’єктивних термінів | Чи можуть два рецензенти не погодитися, чи її виконано («user friendly», «easy», «adequate», «enough»)? | 6.4: «The operator interface shall be user friendly and/or easy to use.» | «The operator interface shall let a trained operator book a ground station contact in no more than 5 minutes.» (ілюстративно; по одній вимозі на кожне важливе завдання) |
| Явні іменники, без займенників | Чи має кожне «it», «its» чи «this» рівно один можливий відповідник? | 1.6.1: «The reference orbit shall repeat its ground track every 3 days.» | «The reference orbit shall repeat the ground track every 3 days.» Тут займенник нешкідливий, але в довшому реченні саме він першим почне означати не те. |
| Зазначено умови | Чи каже вона, коли застосовується значення: етап життя, режим, середовище? | «The solar arrays shall generate 30 W.» | «…at least 30 W orbit-average power at end of life.» |
| Остаточні значення або відстежувані TBD | Чи відстежується кожне відкрите значення з відповідальним і терміном, а не просто вписане в текст? | 3.5: «The thermal design shall keep the battery warm enough (TBD).» | «The thermal design shall keep the battery cell temperature at or above 0 °C while charging.» (ілюстративно; доки тепловий аналіз його не встановить, атрибут TBD називає Thermal Engineer і термін) |
| Без причин і приміток у формулюванні | Чи перенесено фрази про мету («so that», «in order to») і примітки в дужках до обґрунтування? | 3.5: «(TBD)» | Формулювання без дужок; причина в «Обґрунтуванні» |
| Що, а не як | Чи формулює вона потребу, а не нав’язує рішення, яке має вибрати нижчий рівень? | «The thermal design shall keep the battery warm by means of a 2 W film heater.» (ілюстративно) | Переписана вище 3.5: межа температури, а нагрівач залишено на розсуд теплової конструкції |
| Позитивна й досяжна | Чи уникає вона «not», «never», «always», «100%» там, де мається на увазі вимірювана межа? | «The C&DH shall never lose a stored command.» (ілюстративно) | «The C&DH shall execute each stored command within 1 second of the scheduled time.» (4.2 у нинішньому формулюванні) |
| Записано обґрунтування | Чи каже вона, чому вибрано це значення? | 3.1 без обґрунтування | Обґрунтування: «Orbit-average load grew to 26 W after PDR; 30 W keeps 15% margin.» |
| Метод і критерії верифікації | Чи вибрано метод і чи виведено критерій проходження з формулювання? | 3.1: метод Test; TC-06 очікує пікову потужність ≥ 72 W | Критерій проходження, виведений через бюджет потужності: близько 80,6 W пікової для 30 W у середньому за орбіту (див. наступний розділ) |
| Простежується вгору | Пов’язана з потребою, батьківською вимогою чи вимогою-джерелом? | 3.1 без висхідного зв’язку | 3.1 походить від 1.5 Daily Collection Volume |
| Унікальна | Чи каже якась інша вимога те саме іншими словами? | Друга «The battery shall store 77 Wh» у тепловому розділі (ілюстративно) | Одна вимога, 3.2 Battery Capacity, з посиланнями на неї там, де потрібно |
Контрольний список — інструмент рецензента, а не шаблон для написання. Прочитайте кожну вимогу один раз щодо всього списку, а не шукайте по одному правилу за раз, і записуйте зауваження разом із правилом, яке воно порушує, щоб автор знав, що змінити. Правила також мають хибні спрацювання. Перевірка за списком слів позначає «every» в 1.6.1 як універсальний квантор, але «every 3 days» — це період, а не твердження про всі випадки; вирішує рецензент.
Записуйте метод верифікації й критерії приймання разом із вимогою
Верифіковність найлегше перевірити в момент написання вимоги: якщо автор не може сказати, як буде показано її виконання, вона не завершена. Записуйте з кожною вимогою дві речі.
- Метод верифікації: тест, аналіз, огляд чи демонстрація, і рівень збирання, на якому її виконують (компонент, підсистема, система). EO-1 має всі чотири: 3.1 верифікують тестом, 1.5 Daily Collection Volume — аналізом, 3.4 Bus Regulation — оглядом, а 6.1 Contact Scheduling — демонстрацією. Посібник з RVTM пояснює, як вибирати між ними.
- Критерії успіху (критерії приймання): спостережуваний результат, що вважається виконанням, сформульований так, щоб за ним можна було написати тест чи аналіз. Для 3.2 Battery Capacity: «Measured capacity of at least 77 Wh at C/2 and 20 °C.» Для 6.2 Image Delivery: «Products on the portal within 6 h for 95% of passes in rehearsal.»
Запис критеріїв поруч із формулюванням виявляє клас помилок, які інакше знаходять лише наприкінці. 3.1 в EO-1 верифікують тестом TC-06 Solar Array Power Test, який вимірює пікову потужність на імітаторі сонячного випромінювання й проходить при 72 W або більше. Проте вимога стосується середньоорбітальної потужності, а модель перетворює одну на іншу через частку освітленості (0,62) і ККД тракту живлення (0,6). Пікові 72 W дають 72 × 0,62 × 0,6 = 26,8 W у середньому за орбіту, що менше за початкові 28 W, не кажучи вже про нинішні 30 W. Поріг тесту не було виведено з вимоги. TC-06 виміряв 75,1 W і «пройшов», проте 75,1 W відповідають 27,9 W, що не дотягує до обох значень. Якби критерій було написано з формулювання, він становив би близько 30 / (0,62 × 0,6) = 80,6 W пікової потужності, і недобір було б видно вже на першому тесті. Посібник з аналізу впливу змін простежує те саме зауваження через зміну з 28 W на 30 W.
Урок загальний: критерій проходження має простежуватися до значення вимоги через арифметику, яку хтось може перевірити, і ця арифметика належить до обґрунтування чи плану верифікації, а не до пам’яті інженера.
Робота зі значеннями TBD і TBR
На початку проєкту деякі значення ще невідомі. Пропустити вимогу — означає приховати прогалину; вигадати число — приховати невизначеність. Звичайна практика — написати вимогу із заповнювачем і відстежувати заповнювач як відкритий пункт.
- TBD (to be determined, підлягає визначенню): значення ще немає. «The thermal design shall keep the battery cell temperature at or above TBD °C while charging.»
- TBR (to be reviewed, іноді «to be resolved», підлягає уточненню): найкраще поточне значення, яке не підтверджено. «…within 60 seconds» з позначкою TBR на 60.
Віддавайте перевагу TBR з оцінкою над голим TBD скрізь, де є хоч якась основа для числа: проєктувальники можуть працювати з оцінкою, а значення, яке згодом зміниться, — це зміна, яку відстежить простежуваність. Кожен відкритий пункт потребує трьох речей, інакше ним ніхто не керує:
- Відповідальний — людина, яка його закриє.
- Термін або віха, зазвичай до проєктних рішень, що від нього залежать.
- План закриття: аналіз, тест чи рішення, що встановить значення.
Специфікація EO-1 має три відкриті пункти. 3.5 Battery Thermal Control — TBD, за який відповідає Thermal Engineer, і він уже прострочений. 2.4 Target Slew («through 30 degrees within 60 seconds») — TBR, за який відповідає ADCS Lead, а 5.3 Downlink Link Margin («at least 3 dB link margin at 10 degrees elevation») — TBR, за який відповідає Comms Lead; обидва мають робочі значення, якими користуються проєкти, поки аналізи завершуються.
Рахуйте відкриті пункти на кожній віхі й очікуйте, що їх кількість зменшуватиметься. Базова лінія вимог із багатьма відкритими TBD — базова лінія лише за назвою. Критерії рецензування в NASA Systems Engineering Handbook вимагають, починаючи з рецензування системних вимог, щоб відкриті пункти TBD і TBR було визначено з планом і графіком їх закриття. Відстеження належить до атрибута чи реєстру, а не лише до тексту: «TBD», вписане в речення, не має ні відповідального, ні дати, і ніщо не нагадує нікому його закрити.
Типи вимог
Класифікація вимог допомагає рецензентам ставити правильні запитання й зберігати повноту набору. Наведені нижче категорії — поширені; ISO/IEC/IEEE 29148 і посібник INCOSE описують подібні набори, а багато проєктів додають власні.
| Тип | Що формулює | Приклад з EO-1 | На що зважати |
|---|---|---|---|
| Функціональна | Що має робити система | 4.3 Fault Detection: «The C&DH shall enter safe mode within 10 seconds of undervoltage detection.» | Функція без прив’язаної характеристики; більшість функціональних вимог також потребують «наскільки добре», тут — «within 10 seconds» |
| Характеристики | Наскільки добре виконується функція: кількість, частота, точність, час | 2.1 Pointing Accuracy: «The ADCS shall point the payload boresight within 0.1 degrees of the commanded target.» | Відсутні умови (який режим, який етап життя) і відсутній напрямок межі |
| Інтерфейс | Що перетинає межу з іншою системою чи елементом, і його характеристики | 5.2 UHF Command Uplink: «The UHF transceiver shall receive ground commands at 9.6 kbps.» Повне визначення міститься в документі контролю інтерфейсів. | Вимоги, що переказують ICD замість посилатися на нього, через що вони розходяться |
| Обмеження | Обмеження проєкту чи способу побудови системи, накладене ззовні | 4.4 Downlink Encryption: «The C&DH shall encrypt each downlink frame with 256-bit keys.» Її обґрунтування: контракт із замовником вимагає шифрування знімків під час передачі, тож вимога походить ззовні проєкту, а не з компромісу всередині нього. | Проєктні рішення, записані як обмеження, хоча ніхто ззовні їх не накладав |
| Умови середовища, надійність, безпека | Умови, які треба витримати, і надійність, якої треба досягти | 1.7 Mission Lifetime: «The spacecraft shall operate in orbit for at least 730 days.» | Значення без імовірності чи довірчого рівня, з якими їх заявлено |
Межу між функціональними вимогами й вимогами до характеристик часто проводять усередині одного речення: багато вимог формулюють функцію разом з її характеристикою, як 4.3. Це нормально, доки речення містить одне зобов’язання. Вимоги до інтерфейсів докладніше розглянуто в посібнику з документа контролю інтерфейсів, а функції, що стоять за функціональними вимогами, — у посібнику з функціонального аналізу.
Практичний приклад: рецензування специфікації EO-1
Рецензування SRS-001 за контрольним списком ділить 32 вимоги на три групи. Більшість проходять. Кілька мають дрібні зауваження, варті речення кожне. Три потребують переписування.
Автоматична перевірка тієї самої специфікації погоджується з рецензуванням: 29 з 32 вимог оцінено як добрі, а три слабкі потребують доопрацювання. Зауваження до 2.5 перелічують кожне порушене правило за назвою й номером, а саме це потрібно авторові, щоб її виправити. Перевірка також позначає те, чого вона не може вирішити: для 3.1 правильність і здійсненність чекають на рецензента, бо текст змінився після останнього рецензування.
Дрібні зауваження
- 1.6.2 Off-Nadir Imaging, «up to 25 degrees off nadir»: «up to» читається як максимум, але мається на увазі можливість, яку апарат повинен мати за будь-якого кута від 0 до 25 градусів. Хибне прочитання дозволило б відповідати вимозі проєкту, що знімає лише в надир.
- 1.6.1 Ground Track Repeat, «its ground track»: займенник лише з одним можливим відповідником, тож зауваження незначне. «Every» в тому самому реченні — хибне спрацювання правила про універсальний квантор.
- 1.5 Daily Collection Volume має метод (аналіз) і критерії успіху («Simulated daily volume of at least 3.2 GB over a 30-day plan»), але ще не має пов’язаного аналізу. Формулювання гаразд; верифікацію не виконано.
- 3.1 Orbit Average Power написана добре, але її текст змінився після затвердження, тож її правильність і здійсненність знову потребують судження рецензента. Справжнє питання — здійсненність: спроєктовані панелі дають близько 28 W у середньому за орбіту.
Три переписування
2.5 Safe Mode Recovery. «The spacecraft should recover from safe mode quickly and resume imaging as appropriate» порушує щонайменше шість правил: «should» замість «shall», два зобов’язання, поєднані через «and», «quickly» без значення, лазівка «as appropriate», відсутня кінцева крапка й відсутня верифікація. Переписаний варіант зберігає один результат, важливий для замовника, і надає йому значення:
The spacecraft shall resume imaging within 6 hours of a safe mode entry.
Обґрунтування має пояснювати, звідки взялися 6 годин (N1 вимагає сповіщень про стрес посівів того самого дня, а 6.2 дозволяє 6 годин від скидання даних до доставки). Якщо кроки відновлення важливі самі по собі, як-от повторне наведення на Сонце чи повідомлення про причину, кожен стає окремою вимогою. Метод: тест, внесенням відмов на flatsat; критерій успіху: знімання відновлюється протягом 6 годин у кожному внесеному переході в безпечний режим.
3.5 Battery Thermal Control. «The thermal design shall keep the battery warm enough (TBD).» містить розмитий термін, TBD у тексті й дужки. Виправлення розділяє зобов’язання, відкрите значення й причину:
The thermal design shall keep the battery cell temperature at or above 0 °C while charging.
0 °C — ілюстративне значення: літій-іонні елементи зазвичай не заряджають нижче нуля, але справжня межа випливає з паспорта елемента й теплового аналізу. Доки цей аналіз її не встановить, значення є TBR, за яке відповідає Thermal Engineer, із терміном до рецензування теплової конструкції. Переписування також виявляє прогалину, яку приховував оригінал: немає вимоги до діапазону температур розряду, яка потребує власного формулювання.
6.4 Operator Interface. «The operator interface shall be user friendly and/or easy to use.» містить два суб’єктивні терміни й «and/or». Зручність використання можна специфікувати, але лише через спостережувані завдання:
The operator interface shall let a trained operator book a ground station contact in no more than 5 minutes.
Завдання й час ілюстративні. Справжній набір перелічував би кілька важливих завдань (забронювати сеанс зв’язку, передати на борт список цілей, прочитати останню телеметрію стану), кожне з часом і межею помилок, виміряними під час демонстрації з операторами, які пройшли навчання.
Типові помилки
| Помилка | Що йде не так | Краще |
|---|---|---|
| Записувати проєктні рішення як вимоги | Проєкт фіксується до аналізу компромісів, і кращий варіант відкидається без чийогось рішення. | Сформулюйте потребу («тримати елементи при 0 °C або вище під час заряджання») і дайте нижчому рівню вибрати нагрівач. |
| Копіювати мову зацікавлених сторін просто у вимоги | «Свіжі знімки двічі на тиждень» — це потреба; у такому формулюванні вона не верифіковна. | Збережіть потребу й напишіть вимогу зі значенням і умовою, яка її задовольняє (1.6 протягом 72 годин). |
| Кілька вимог в одному абзаці | Один ідентифікатор несе кілька зобов’язань, які мають спільний статус, спільний тест і спільну долю. | Одна вимога на елемент, одне «shall» на формулювання. |
| Значення без умов | «30 W» на початку й наприкінці строку служби — це різні проєкти. | Зазначайте режим, етап життя, середовище й усереднення. |
| Немає обґрунтування | Ніхто не може оцінити пізнішу зміну, а вимога живе ще довго після того, як зникла її причина. | Записуйте причину й числа, що стоять за значенням. |
| Пороги тестів, не виведені з вимоги | Тест проходить, хоча вимогу не виконано (TC-06 при пікових 72 W проти 28 W у середньому за орбіту). | Виведіть критерій успіху з формулювання арифметично й запишіть його. |
| TBD, вписане в текст і забуте | Відкрите значення не має відповідального чи дати й потрапляє до базової лінії. | Відстежуйте кожне TBD і TBR з відповідальним, терміном і планом закриття. |
| Надмірність вимог | Вимоги, яких ніхто не просив, забирають зусилля на проєктування й випробування. | Перевіряйте, що кожна вимога верхнього рівня простежується до потреби чи джерела. |
| Надмірна довіра до автоматичних перевірок | Чиста перевірка слів сприймається як правильна вимога. | Використовуйте інструменти для механічних правил; правильність, здійсненність і необхідність оцінює людина. |
Спробуйте в Holarch
У проєкті LML кожна вимога — це сутність класу Requirement з описаними вище атрибутами: Rationale, Status, Priority, Criticality, Owner, Source, Verification Method, Verification Level, Success Criteria і полями TBD/TBR.
- Створіть демопроєкт через Керування проєктами → Файли проєкту ▾ → Новий демопроєкт → CubeSat (системна інженерія з посібником). Його специфікація містить три слабкі вимоги й відкриті пункти TBD/TBR, використані в цьому посібнику.
- Відкрийте Потреби та вимоги → Якість, виберіть документ у списку області й натисніть Перевірити якість. Кожну вимогу оцінюють за дев’ятьма характеристиками, а пропозиції називають номери правил із посібника INCOSE, які може перевірити список слів чи шаблон. Correct і Feasible потребують рецензента: клацніть позначку, щоб записати рішення.
- Перепишіть 2.5, як показано вище, і запустіть перевірку знову. Зауваження щодо сполучника, лазівки й розмитого терміна зникають.
- Відкрийте Потреби та вимоги → TBD/TBR, щоб побачити відкриті пункти з відповідальними й термінами, і натисніть Закрити для пункту, щойно його значення визначено.
- Щоб отримати другу думку щодо характеристик, яких не може вирішити правило, скористайтеся ✦ ШІ ▾ → Перевірка вимог ШІ; кожен вердикт і кожне переписування показано для рецензування, перш ніж щось зміниться.
Повний довідник — у документації Якість вимог і Реєстр TBD/TBR.
Завантажте контрольний список
Контрольний список якості вимог із прикладами EO-1 «до» і «після» (CSV) містить правила контрольного списку із запитаннями для рецензування й прикладами, для використання під час рецензування або як відправну точку для власних правил написання в проєкті. Той самий файл пропонує посібник із простежуваності.
Запитання про написання вимог
Shall, must чи will?
Підходить будь-яка конвенція, якщо специфікація її визначає й дотримується її. Найпоширеніша використовує «shall» для обов’язкових вимог, «will» для фактів і намірів щодо речей поза системою і «should» для цілей, які не верифікуються. Деякі державні посібники зі стилю віддають перевагу «must» з міркувань простої мови. Справжня проблема — змішувати їх в одній специфікації.
Скільки вимог має бути в системи?
Правильного числа немає. Малий космічний апарат може мати кілька десятків системних вимог і кілька сотень під ними; велика програма має тисячі. Корисніші запитання — чи кожна вимога простежується до потреби чи батьківської вимоги і чи кожна потреба має під собою вимоги.
Чи є історії користувачів вимогами?
Історія користувача фіксує потребу та її мету в термінах користувача. Вона відіграє роль потреби зацікавленої сторони, а її критерії приймання близькі до критеріїв верифікації. Для системи, яку будують, інтегрують і верифікують як апаратне й програмне забезпечення разом, історії все одно треба перетворити на вимоги, які можна розподілити й випробувати.
Чи може інструмент перевіряти якість вимог?
Інструмент може надійно перевіряти механічні правила: модальні дієслова, сполучники, розмиті слова, лазівки, займенники, відсутні зв’язки. Він не може знати, чи 30 W — правильне значення і чи можуть панелі його забезпечити. Використовуйте автоматичну перевірку, щоб усунути механічні зауваження до рецензування, і тоді рецензенти витрачатимуть час на правильність і здійсненність.
Куди далі
- Простежуваність вимог і вплив змін: пов’яжіть ці вимоги з потребами, проєктом і тестами та простежте зміну.
- Функціональний аналіз: перетворіть вимоги на функції й розподіліть їх.
- Матриця верифікації вимог: сплануйте метод верифікації для кожної вимоги й запишіть результати.
- Потреби та вимоги в Holarch: документи, перевірки якості, базові лінії й простежуваність в одній моделі.