Przewodnik · Wymagania
Jak pisać dobre wymagania systemowe: przykłady i lista kontrolna
Posłuchaj tego przewodnika 26 min
Dobre wymaganie mówi jedną rzecz, którą system musi robić lub czym musi być, słowami, które dwóch inżynierów odczyta tak samo, z wartością, którą może sprawdzić test lub analiza. Ten przewodnik omawia potrzeby a wymagania, części zapisu wymagania, cechy jakości według ISO/IEC/IEEE 29148 i INCOSE Guide to Writing Requirements, listę kontrolną z przykładami przed poprawką i po niej, metody weryfikacji i kryteria akceptacji, wartości TBD i TBR oraz typy wymagań, wszystko na jednej specyfikacji CubeSata.
Na tej stronie
- Dlaczego sformułowanie wymagania ma znaczenie
- Potrzeby interesariuszy a wymagania
- Budowa wymagania
- Cechy jakości dobrego wymagania
- Lista kontrolna: reguły z przykładami przed poprawką i po niej
- Zapisz metodę weryfikacji i kryteria akceptacji razem z wymaganiem
- Postępowanie z wartościami TBD i TBR
- Typy wymagań
- Przykład krok po kroku: przegląd specyfikacji EO-1
- Typowe błędy
- Wypróbuj w Holarch
- Pobierz listę kontrolną
- Pytania o pisanie wymagań
- Co dalej
Dlaczego sformułowanie wymagania ma znaczenie
Wymaganie to umowa między osobami, które zamawiają system, a osobami, które go budują. Czyta je wszystko, co następuje później: projektant wymiaruje względem niego komponent, inżynier testów wyprowadza z niego kryterium zaliczenia, komisja ds. zmian waży względem niego zmianę, a klient na jego podstawie odbiera system. Każdy z nich czyta to samo zdanie, zwykle bez autora w pobliżu. Jeśli zdanie da się odczytać na dwa sposoby, tak się stanie, a różnica wyjdzie na jaw późno: podczas testu, który „przechodzi” według kryterium, na które nikt się nie zgodził, albo przy odbiorze, gdy klient miał na myśli coś innego.
Złe sformułowanie psuje też resztę modelu. Wymagania bez wartości nie da się alokować do komponentu, bo nikt nie może powiedzieć, czy komponent je spełnia. Nie da się go zweryfikować, więc pojawia się jako luka w pokryciu w identyfikowalności i w macierzy weryfikacji. A gdy się zmienia, nikt nie wie, czy powiązany projekt nadal jest aktualny. Dobre pisanie wymagań to najtańsza praca nad jakością w projekcie: godzina poświęcona zdaniu na początku oszczędza kampanię testów na końcu.
Przewodnik korzysta z jednego przykładu przewijającego się przez całość: EO-1, fikcyjnego CubeSata 6U, który fotografuje pola uprawne w czterech pasmach widmowych. Jego specyfikacja, SRS-001 EO-1 System Requirements Specification, zawiera 32 wymagania, w większości poprawne, a trzy celowo słabe. To ten sam model co w kompleksowym przykładowym projekcie MBSE. Przytoczone tu potrzeby interesariuszy od N1 do N3 to te, które do modelu dodaje przewodnik po identyfikowalności.
Potrzeby interesariuszy a wymagania
Pisanie wymagań zaczyna się o krok wcześniej, od potrzeb. Potrzeba interesariusza to oczekiwanie użytkownika, operatora, klienta lub regulatora, wyrażone jego własnymi słowami. Wymaganie to inżynierskie stwierdzenie, względem którego system jest projektowany i weryfikowany. ISO/IEC/IEEE 15288 rozdziela je na osobne procesy techniczne: definiowanie potrzeb i wymagań interesariuszy (6.4.2) oraz definiowanie wymagań systemowych (6.4.3). INCOSE Needs and Requirements Manual stosuje ten sam podział i traktuje potrzeby jako pełnoprawne elementy, a nie szkice wymagań.
| Przykład z EO-1 | Sprawdzane przez | |
|---|---|---|
| Potrzeba (N2 Twice-Weekly Revisit) | Klienci rolni potrzebują aktualnych zdjęć swoich pól co najmniej dwa razy w tygodniu w sezonie wegetacyjnym. | Walidację: czy klienci otrzymują od dostarczonego systemu to, czego potrzebują? |
| Wymaganie (1.6 Revisit Time) | Misja musi ponownie obserwować każdy region docelowy w ciągu 72 godzin. | Weryfikację: czy system spełnia zapis, co wykazuje test, analiza, inspekcja lub demonstracja? |
Różnicę widać w sposobie sprawdzania. Wymaganie jest weryfikowane: system mierzy się względem zapisu. Potrzeba jest walidowana: ktoś potwierdza, że system w zamierzonym użyciu robi to, czego chciał interesariusz. System może przejść każdą weryfikację, a mimo to nie przejść walidacji, jeśli wymagania minęły się z celem; tę lukę omawia przewodnik o weryfikacji i walidacji. Dla pisania praktyczny wniosek jest prosty: najpierw zapisz potrzebę, potem wymagania, które by ją zaspokoiły, gdyby zostały spełnione, i powiąż każde wymaganie z potrzebą, na którą odpowiada.
Przełożenie rzadko jest jeden do jednego. N2 staje się 1.6 Revisit Time, które następnie dekomponuje się na 1.6.1 Ground Track Repeat (3 dni) i 1.6.2 Off-Nadir Imaging (25 stopni). Niektóre wymagania nie odpowiadają bezpośrednio na żadną potrzebę: 3.1 Orbit Average Power wynika z 1.5 Daily Collection Volume, ponieważ obciążenie związane z obrazowaniem określa moc, którą muszą dostarczyć panele. Żaden klient nie prosił o 30 W, ale obrazowanie, o które prosili, nie jest bez tego możliwe.
Budowa wymagania
Wymaganie to więcej niż jego zdanie. Zdanie niesie zobowiązanie; zestaw otaczających je atrybutów niesie uzasadnienie, plan wykazania spełnienia i ewidencję. Obie połowy są częścią jego pisania.
Zapis wymagania
Większość dobrych zapisów wymagań pasuje do jednego wzorca. ISO/IEC/IEEE 29148 (5.2.4) opisuje go jako podmiot, czynność, obiekt i ograniczenia czynności, z opcjonalnym warunkiem na początku; INCOSE Guide to Writing Requirements zaleca tę samą kolejność i uzgodnione szablony dla każdego rodzaju wymagań.
| Część | Co określa | EO-1 4.3 Fault Detection |
|---|---|---|
| Warunek (opcjonalny) | Kiedy, w jakim trybie lub stanie obowiązuje wymaganie | „…of undervoltage detection” (zdarzenie wyzwalające) |
| Podmiot | System lub element, który musi spełnić wymaganie, dokładnie nazwany | „The C&DH” |
| Czasownik modalny | Siła zobowiązania | „shall” |
| Czynność | Co podmiot robi lub czym jest, jako czasownik w stronie czynnej | „enter” |
| Obiekt | Czego dotyczy czynność | „safe mode” |
| Wydajność lub ograniczenie | Mierzalna wartość z jednostką i kierunkiem granicy | „within 10 seconds” |
Razem: „The C&DH shall enter safe mode within 10 seconds of undervoltage detection.” (C&DH musi przejść w tryb bezpieczny w ciągu 10 sekund od wykrycia podnapięcia). Kolejność może się zmieniać („When undervoltage is detected, the C&DH shall…” stawia warunek na początku, jak w szablonach EARS stosowanych przez wiele zespołów), ale każda część powinna być obecna albo świadomie pominięta.
Największy ciężar niosą trzy słowa. Shall oznacza wiążące wymaganie; will stwierdza fakt lub zamiar dotyczący czegoś poza systemem; should określa cel, który nie jest weryfikowany. Niezależnie od konwencji przyjętej w projekcie zdefiniuj ją raz w specyfikacji i trzymaj się jej. EO-1 1.1 Reference Orbit („The mission assumes a 500 km sun-synchronous orbit…”) jest poprawnie zapisane jako założenie, a nie wymaganie: stanowi kontekst dla zależnych od niego wymagań, a model przechowuje je jako stwierdzenie, które nie jest oceniane ani weryfikowane.
Atrybuty
Oto 3.1 Orbit Average Power w postaci zapisanej w modelu EO-1, po zmianie z 28 W na 30 W po PDR:
| Atrybut | 3.1 Orbit Average Power | Po co jest |
|---|---|---|
| Identyfikator i nazwa | 3.1 Orbit Average Power | Stały uchwyt dla powiązań, przeglądów i wniosków o zmianę |
| Zapis | Panele słoneczne muszą generować co najmniej 30 W średniej mocy na orbicie pod koniec okresu eksploatacji. | Samo zobowiązanie |
| Uzasadnienie | Średnie obciążenie na orbicie wzrosło po PDR do 26 W; 30 W utrzymuje 15% zapasu. | Pozwala późniejszemu czytelnikowi ocenić zmianę bez autora |
| Źródło i element nadrzędny | Derived (systems analysis); wynika z 1.5 Daily Collection Volume | Identyfikowalność wstecz: dlaczego wymaganie istnieje |
| Metoda i poziom weryfikacji | Test, na poziomie podsystemu | Plan wykazania spełnienia, ustalony podczas pisania |
| Kryteria sukcesu | Średnia moc na orbicie pod koniec okresu eksploatacji prognozowana na podstawie zmierzonej mocy szczytowej. | Jaki wynik oznacza spełnienie |
| Właściciel, priorytet, krytyczność | Power Engineer; High; High | Kto za nie odpowiada i jak bardzo jest ważne |
| Status | In Review (miało status Approved; jego tekst zmienił się po zatwierdzeniu) | Na jakim etapie procesu uzgadniania się znajduje |
| TBD/TBR | Brak | Czy jakaś wartość jest nadal otwarta |
ISO/IEC/IEEE 29148 (5.2.8) wymienia atrybuty tego rodzaju, a przewodnik INCOSE dodaje kolejne; projekt wybiera te, które faktycznie będzie utrzymywać. Uzasadnienie jest najczęściej pomijane i najczęściej brakuje go później. Bez „obciążenie 26 W, zapas 15%” następna osoba, która zobaczy 3.1, nie wie, czy 30 W to twarda granica fizyczna, liczba od klienta czy wybór zapasu, a więc nie wie, co oznacza dla niego zmiana obciążenia.
Cechy jakości dobrego wymagania
Reguły stylu łatwiej stosować, gdy wiadomo, co chronią. ISO/IEC/IEEE 29148 (5.2.5) wymienia dziewięć cech pojedynczego wymagania, a INCOSE Guide to Writing Requirements używa tych samych dziewięciu jako C1–C9, każdą z krótką definicją i wspierającymi ją regułami. Tabela przedstawia każdą z nich jako pytanie, które może zadać recenzent.
| Cecha | Pytanie do zadania | Przykład z EO-1 |
|---|---|---|
| Niezbędne | Czy po usunięciu wymagania przepadłoby coś, czego potrzebują interesariusze? Czy nie jest duplikatem? | 3.1 jest niezbędne: bez niego nic nie wymiaruje paneli pod obciążenie związane z obrazowaniem. |
| Odpowiednie | Czy jest zapisane na właściwym poziomie, bez przesądzania wyboru projektowego, który należy do poziomu niższego? | 3.1 określa poziom mocy paneli, a nie typ ogniw czy liczbę paneli. |
| Jednoznaczne | Czy można je odczytać tylko w jeden sposób? | 6.4 „user friendly” nie spełnia tej cechy: dwóch recenzentów nie zgodzi się, czy jest spełnione. |
| Kompletne | Czy mówi wszystko, co potrzebne, bez brakującego warunku lub wartości? | 3.5 „warm enough (TBD)” nie spełnia tej cechy: brakuje wartości. |
| Pojedyncze | Czy określa jedno zobowiązanie? | 2.5 nie spełnia tej cechy: żąda wyjścia z trybu bezpiecznego i wznowienia obrazowania, połączonych przez „and”. |
| Wykonalne | Czy można je spełnić w znanych ograniczeniach technologii, kosztu i harmonogramu? | 3.1 przy 30 W stoi pod znakiem zapytania: zaprojektowane panele dają około 28 W średnio na orbicie. |
| Weryfikowalne | Czy test, analiza, inspekcja lub demonstracja może wykazać jego spełnienie? | 2.5 „quickly” nie spełnia tej cechy; „within 6 hours” spełnia. |
| Poprawne | Czy wyraża rzeczywistą potrzebę swojego źródła, z właściwą wartością? | 1.2 z odległością próbkowania terenu 4,5 m poprawnie wyraża potrzebę N3 dotyczącą map na poziomie pola, z zapasem. |
| Zgodne z konwencją | Czy stosuje uzgodnione w projekcie szablony i słownictwo? | Każde wymaganie EO-1 używa „shall”, nazwanego podmiotu i jednostek SI. |
Zbiór wymagań ma własne cechy, których nie może pokazać żaden pojedynczy zapis. ISO/IEC/IEEE 29148 (5.2.6) wymienia dla zbioru cechy: kompletny, spójny, wykonalny jako całość, zrozumiały i możliwy do walidacji; przewodnik INCOSE dodaje poprawny jako C15 i numeruje cechy zbioru od C10 do C15.
- Kompletny: zbiór pokrywa potrzeby. EO-1 określa, co dzieje się przy podnapięciu (4.3), ale jedynym wymaganiem dotyczącym wyjścia z trybu bezpiecznego jest 2.5, którego w obecnym brzmieniu nie da się zweryfikować, więc wyjście z tego trybu w praktyce nie jest określone.
- Spójny: żadne dwa wymagania nie są sprzeczne, a terminy i jednostki są używane w ten sam sposób. 1.5 żąda 3,2 GB danych zdjęciowych dziennie, a 5.4 3 GB odebranych na Ziemi; zgadzają się tylko dlatego, że uzasadnienie 5.4 mówi „after compression”. Bez uzasadnienia wyglądają na sprzeczne.
- Wykonalny: wymagania można spełnić łącznie. Każde wymaganie dotyczące mocy może być wykonalne osobno, podczas gdy 30 W średnio na orbicie, powierzchnia paneli i budżet masy razem mogą nie być.
- Zrozumiały: czytelnik potrafi określić, czego oczekuje się od systemu i jak wymagania są ze sobą powiązane, co zależy w równym stopniu od struktury, numeracji i identyfikowalności, jak od sformułowań.
- Możliwy do walidacji: można wykazać, że zbiór prowadzi do systemu spełniającego potrzeby, dlatego każde wymaganie najwyższego poziomu jest powiązane z potrzebą.
Lista kontrolna: reguły z przykładami przed poprawką i po niej
Cechy stają się użyteczne dzięki konkretnym regułom pisania. INCOSE Guide to Writing Requirements numeruje je (R1, R2 i tak dalej); NASA Systems Engineering Handbook (dodatek C) zawiera krótszą listę kontrolną w tym samym duchu. Tabela zbiera reguły, które w praktyce wychwytują większość problemów, z przykładem ze specyfikacji EO-1 dla każdej z nich. „Przed” to tekst w obecnej postaci w projekcie demonstracyjnym; „Po” to przeredagowanie. Wartości oznaczone jako przykładowe pokazują formę, a nie wyniki analiz EO-1.
| Reguła | Pytanie do zadania | Przed (EO-1) | Po |
|---|---|---|---|
| Jedno zobowiązanie na zapis | Dokładnie jedno „shall”, bez „and”, „or”, „and/or” łączących dwa żądania? | 2.5: „Statek kosmiczny powinien szybko wychodzić z trybu bezpiecznego i w razie potrzeby wznawiać obrazowanie” | „Statek kosmiczny musi wznowić obrazowanie w ciągu 6 godzin od wejścia w tryb bezpieczny.” Dalsze istotne kroki wyjścia z tego trybu otrzymują własne wymagania. |
| Sformułowanie obligatoryjne | „Shall” dla wiążącego wymagania, a nie „should”, „will” ani „may”? | 2.5: „should recover” | „shall resume” |
| Mierzalna wartość z jednostką | Czy każde słowo dotyczące wydajności ma liczbę i jednostkę? | 2.5: „szybko” | „w ciągu 6 godzin od wejścia w tryb bezpieczny” |
| Określony kierunek granicy | Czy jasne jest, czy wartość jest minimum, czy maksimum? | 1.6.2: „fotografować cele odchylone od nadiru o nie więcej niż 25 stopni” | „fotografować cele pod kątami odchylenia od nadiru od 0 do 25 stopni” (zakres możliwości, a nie limit celowania) |
| Bez furtek | Czy coś pozostawiono ocenie dostawcy („w razie potrzeby”, „jeśli to możliwe”, „gdzie to praktyczne”)? | 2.5: „w razie potrzeby” | Usunięte; podany jest istotny warunek |
| Bez niejasnych lub subiektywnych określeń | Czy dwóch recenzentów mogłoby się nie zgodzić, czy wymaganie jest spełnione („przyjazny dla użytkownika”, „łatwy”, „odpowiedni”, „wystarczający”)? | 6.4: „Interfejs operatora musi być przyjazny dla użytkownika i/lub łatwy w obsłudze.” | „Interfejs operatora musi umożliwiać przeszkolonemu operatorowi zarezerwowanie kontaktu ze stacją naziemną w czasie nie dłuższym niż 5 minut.” (przykładowe; jedno wymaganie na każde istotne zadanie) |
| Jawne rzeczowniki, bez zaimków | Czy każde „on”, „jego” lub „ten” ma dokładnie jeden możliwy desygnat? | 1.6.1: „Orbita odniesienia musi powtarzać swój ślad naziemny co 3 dni.” | „Orbita odniesienia musi powtarzać ślad naziemny co 3 dni.” Zaimek jest tu nieszkodliwy, ale w dłuższym zdaniu to on pierwszy traci jednoznaczność. |
| Określone warunki | Czy mówi, kiedy wartość obowiązuje: etap życia, tryb, środowisko? | „Panele słoneczne muszą generować 30 W.” | „…co najmniej 30 W średniej mocy na orbicie pod koniec okresu eksploatacji.” |
| Ustalone wartości lub śledzone TBD | Czy każda otwarta wartość jest śledzona z właścicielem i terminem, a nie tylko wpisana w tekst? | 3.5: „Projekt termiczny musi utrzymywać akumulator w wystarczająco wysokiej temperaturze (TBD).” | „Projekt termiczny musi utrzymywać temperaturę ogniw akumulatora na poziomie co najmniej 0 °C podczas ładowania.” (przykładowe; dopóki analiza termiczna jej nie ustali, atrybut TBD wskazuje Thermal Engineer i termin) |
| Bez uzasadnień i uwag w zapisie | Czy wyrażenia celu („tak aby”, „w celu”) i uwagi w nawiasach przeniesiono do uzasadnienia? | 3.5: „(TBD)” | Zapis bez nawiasów; powód w polu Rationale |
| Co, a nie jak | Czy określa potrzebę zamiast narzucać rozwiązanie, które powinien wybrać niższy poziom? | „Projekt termiczny musi utrzymywać akumulator w cieple za pomocą grzałki foliowej 2 W.” (przykładowe) | Powyższe przeredagowanie 3.5: granica temperatury, a grzałka pozostawiona projektowi termicznemu |
| Pozytywne i osiągalne | Czy unika „nie”, „nigdy”, „zawsze”, „100%” tam, gdzie chodzi o mierzalną granicę? | „C&DH nigdy nie może utracić zapisanego polecenia.” (przykładowe) | „C&DH musi wykonywać każde zapisane polecenie w ciągu 1 sekundy od zaplanowanego czasu.” (4.2 w obecnym brzmieniu) |
| Zapisane uzasadnienie | Czy mówi, dlaczego wybrano tę wartość? | 3.1 bez uzasadnienia | Uzasadnienie: „Średnie obciążenie na orbicie wzrosło po PDR do 26 W; 30 W utrzymuje 15% zapasu.” |
| Metoda i kryteria weryfikacji | Czy metoda jest wybrana, a kryterium zaliczenia wyprowadzone z zapisu? | 3.1: metoda Test; TC-06 oczekuje mocy szczytowej ≥ 72 W | Kryterium zaliczenia wyprowadzone przez budżet mocy: około 80,6 W mocy szczytowej dla 30 W średnio na orbicie (zob. następną sekcję) |
| Identyfikowalne w górę | Powiązane z potrzebą, elementem nadrzędnym lub wymaganiem źródłowym? | 3.1 bez powiązania w górę | 3.1 wynika z 1.5 Daily Collection Volume |
| Unikalne | Czy inne wymaganie mówi to samo innymi słowami? | Drugie „Akumulator musi gromadzić 77 Wh” w sekcji termicznej (przykładowe) | Jedno wymaganie, 3.2 Battery Capacity, przywoływane tam, gdzie jest potrzebne |
Lista kontrolna to narzędzie recenzenta, a nie szablon do pisania. Przeczytaj każde wymaganie raz względem całej listy, zamiast szukać po jednej regule naraz, i zapisz ustalenie wraz z regułą, którą narusza, aby autor wiedział, co zmienić. Reguły mają też fałszywe alarmy. Kontrola oparta na liście słów oznacza „every” w 1.6.1 jako kwantyfikator ogólny, ale „every 3 days” to okres, a nie twierdzenie o wszystkich przypadkach; decyduje recenzent.
Zapisz metodę weryfikacji i kryteria akceptacji razem z wymaganiem
Cechę weryfikowalności najłatwiej sprawdzić w chwili pisania wymagania: jeśli autor nie potrafi powiedzieć, jak wykazać jego spełnienie, wymaganie nie jest skończone. Przy każdym wymaganiu zapisz dwie rzeczy.
- Metoda weryfikacji: test, analiza, inspekcja lub demonstracja oraz poziom złożenia, na którym jest wykonywana (komponent, podsystem, system). EO-1 korzysta ze wszystkich czterech: 3.1 jest weryfikowane testem, 1.5 Daily Collection Volume analizą, 3.4 Bus Regulation inspekcją, a 6.1 Contact Scheduling demonstracją. Przewodnik po RVTM wyjaśnia, jak wybierać między nimi.
- Kryteria sukcesu (kryteria akceptacji): obserwowalny wynik, który oznacza spełnienie, określony tak, by można było na jego podstawie napisać test lub analizę. Dla 3.2 Battery Capacity: „Zmierzona pojemność co najmniej 77 Wh przy C/2 i 20 °C.” Dla 6.2 Image Delivery: „Produkty w portalu w ciągu 6 h dla 95% przelotów w próbie generalnej.”
Zapisywanie kryteriów obok zapisu wymagania wychwytuje klasę błędów, które inaczej wychodzą na jaw dopiero na końcu. 3.1 z EO-1 jest weryfikowane przez TC-06 Solar Array Power Test, który mierzy moc szczytową na symulatorze słonecznym i jest zaliczany przy 72 W lub więcej. Wymaganie dotyczy jednak średniej mocy na orbicie, a model przelicza jedną na drugą przy użyciu udziału nasłonecznienia (0,62) i sprawności toru mocy (0,6). 72 W mocy szczytowej daje 72 × 0,62 × 0,6 = 26,8 W średnio na orbicie, czyli mniej niż pierwotne 28 W, nie mówiąc o obecnych 30 W. Próg testu nie został wyprowadzony z wymagania. TC-06 zmierzył 75,1 W i „został zaliczony”, a jednak 75,1 W przelicza się na 27,9 W, poniżej obu wartości. Gdyby kryterium wyprowadzono z zapisu, wynosiłoby około 30 / (0,62 × 0,6) = 80,6 W mocy szczytowej, a niedobór byłby widoczny przy pierwszym teście. Przewodnik po analizie wpływu zmian śledzi to samo ustalenie przez zmianę z 28 W na 30 W.
Wniosek jest ogólny: kryterium zaliczenia powinno dać się powiązać z wartością wymagania obliczeniem, które ktoś może sprawdzić, a to obliczenie należy do uzasadnienia lub planu weryfikacji, a nie do pamięci inżyniera.
Postępowanie z wartościami TBD i TBR
Na początku projektu niektóre wartości nie są jeszcze znane. Pominięcie wymagania ukrywa lukę; wymyślenie liczby ukrywa niepewność. Typowa praktyka to zapisanie wymagania z symbolem zastępczym i śledzenie tego symbolu jako otwartej kwestii.
- TBD (to be determined, do ustalenia): brak wartości. „Projekt termiczny musi utrzymywać temperaturę ogniw akumulatora na poziomie co najmniej TBD °C podczas ładowania.”
- TBR (to be reviewed, do przeglądu, czasem „to be resolved”, do rozstrzygnięcia): najlepsza obecna wartość, która nie jest potwierdzona. „…w ciągu 60 sekund” z wartością 60 oznaczoną jako TBR.
Wszędzie tam, gdzie istnieje jakakolwiek podstawa do liczby, wybieraj TBR z oszacowaniem zamiast samego TBD: projektanci mogą pracować na oszacowaniu, a wartość, która później się przesunie, jest zmianą, za którą podąży identyfikowalność. Każda otwarta kwestia potrzebuje trzech rzeczy, inaczej nie jest zarządzana:
- Właściciela, czyli osoby, która ją zamknie.
- Terminu lub kamienia milowego, zwykle przed decyzjami projektowymi, które od niej zależą.
- Planu zamknięcia: analizy, testu lub decyzji, które ustalą wartość.
Specyfikacja EO-1 ma trzy otwarte kwestie. 3.5 Battery Thermal Control to TBD, którego właścicielem jest Thermal Engineer, już po terminie. 2.4 Target Slew („through 30 degrees within 60 seconds”) to TBR, którego właścicielem jest ADCS Lead, a 5.3 Downlink Link Margin („at least 3 dB link margin at 10 degrees elevation”) to TBR, którego właścicielem jest Comms Lead; oba mają robocze wartości, z których korzystają projekty, dopóki analizy się nie zakończą.
Licz otwarte kwestie na każdym kamieniu milowym i oczekuj, że ich liczba będzie maleć. Linia bazowa wymagań z wieloma otwartymi TBD jest linią bazową tylko z nazwy. Kryteria przeglądów w NASA Systems Engineering Handbook wymagają, począwszy od przeglądu wymagań systemowych, aby otwarte pozycje TBD i TBR były zidentyfikowane wraz z planem i harmonogramem ich zamknięcia. Śledzenie należy do atrybutu lub rejestru, a nie tylko do tekstu: „TBD” wpisane w zdanie nie ma właściciela ani terminu i nic nikomu nie przypomina o jego zamknięciu.
Typy wymagań
Klasyfikowanie wymagań pomaga recenzentom zadawać właściwe pytania i pomaga utrzymać kompletność zbioru. Poniższe kategorie są najczęstsze; ISO/IEC/IEEE 29148 i przewodnik INCOSE opisują podobne zestawy, a wiele projektów dodaje własne.
| Typ | Co określa | Przykład z EO-1 | Na co uważać |
|---|---|---|---|
| Funkcjonalne | Co system musi robić | 4.3 Fault Detection: „C&DH musi przejść w tryb bezpieczny w ciągu 10 sekund od wykrycia podnapięcia.” | Funkcja bez dołączonej wydajności; większość wymagań funkcjonalnych potrzebuje też określenia „jak dobrze”, tutaj „w ciągu 10 sekund” |
| Wydajnościowe | Jak dobrze funkcja jest wykonywana: ilość, częstotliwość, dokładność, czas | 2.1 Pointing Accuracy: „ADCS musi kierować oś optyczną ładunku użytecznego z dokładnością do 0,1 stopnia względem zadanego celu.” | Brakujące warunki (który tryb, który etap życia) i brakujący kierunek granicy |
| Interfejs | Co przekracza granicę z innym systemem lub elementem i jakie ma właściwości | 5.2 UHF Command Uplink: „Nadajnik-odbiornik UHF musi odbierać polecenia z Ziemi z szybkością 9,6 kb/s.” Pełna definicja znajduje się w dokumencie kontroli interfejsów. | Wymagania, które powtarzają ICD zamiast się do niego odwoływać, przez co oba z czasem się rozjeżdżają |
| Ograniczenie | Granica narzucona z zewnątrz projektowi lub sposobowi budowy systemu | 4.4 Downlink Encryption: „C&DH musi szyfrować każdą ramkę transmisji w dół kluczami 256-bitowymi.” Uzasadnienie: umowa z klientem wymaga szyfrowania zdjęć w transmisji, więc wymaganie pochodzi spoza projektu, a nie z analizy kompromisów w jego ramach. | Wybory projektowe zapisane jako ograniczenia, choć nikt z zewnątrz ich nie narzucił |
| Środowiskowe, niezawodnościowe, bezpieczeństwa | Warunki, które trzeba przetrwać, i niezawodność, którą trzeba osiągnąć | 1.7 Mission Lifetime: „Statek kosmiczny musi działać na orbicie przez co najmniej 730 dni.” | Wartości bez prawdopodobieństwa lub poziomu ufności, przy którym są deklarowane |
Granica między wymaganiami funkcjonalnymi a wydajnościowymi często przebiega wewnątrz jednego zdania: wiele wymagań określa funkcję wraz z jej wydajnością, tak jak 4.3. To w porządku, dopóki zdanie nadal zawiera jedno zobowiązanie. Wymagania interfejsowe omawia szerzej przewodnik po dokumencie kontroli interfejsów, a funkcje stojące za wymaganiami funkcjonalnymi przewodnik po analizie funkcjonalnej.
Przykład krok po kroku: przegląd specyfikacji EO-1
Przegląd SRS-001 według listy kontrolnej dzieli 32 wymagania na trzy grupy. Większość przechodzi. Kilka ma drobne ustalenia, każde warte jednego zdania. Trzy wymagają przeredagowania.
Automatyczna kontrola tej samej specyfikacji zgadza się z przeglądem: 29 z 32 wymagań ocenia jako dobre, a trzy słabe wymagają poprawy. Ustalenia dla 2.5 wymieniają każdą naruszoną regułę z nazwy i numeru, a tego właśnie potrzebuje autor, by je poprawić. Kontrola oznacza też to, czego nie potrafi rozstrzygnąć: w 3.1 poprawność i wykonalność czekają na recenzenta, ponieważ tekst zmienił się po ostatnim przeglądzie.
Drobne ustalenia
- 1.6.2 Off-Nadir Imaging, „up to 25 degrees off nadir”: „up to” brzmi jak maksimum, ale intencją jest zdolność, którą statek musi mieć przy dowolnym kącie od 0 do 25 stopni. Błędne odczytanie pozwoliłoby uznać za zgodny projekt, który fotografuje tylko w nadirze.
- 1.6.1 Ground Track Repeat, „its ground track”: zaimek ma tylko jeden możliwy desygnat, więc ustalenie jest drobne. „Every” w tym samym zdaniu to fałszywy alarm reguły dotyczącej kwantyfikatorów ogólnych.
- 1.5 Daily Collection Volume ma metodę (analiza) i kryteria sukcesu („Simulated daily volume of at least 3.2 GB over a 30-day plan”), ale jeszcze nie ma powiązanej analizy. Sformułowanie jest w porządku; weryfikacja nie została wykonana.
- 3.1 Orbit Average Power jest dobrze napisane, ale jego tekst zmienił się po zatwierdzeniu, więc jego poprawność i wykonalność ponownie wymagają oceny recenzenta. Prawdziwym pytaniem jest wykonalność: zaprojektowane panele dają około 28 W średnio na orbicie.
Trzy przeredagowania
2.5 Safe Mode Recovery. „The spacecraft should recover from safe mode quickly and resume imaging as appropriate” narusza co najmniej sześć reguł: „should” zamiast „shall”, dwa zobowiązania połączone przez „and”, „quickly” bez wartości, furtka „as appropriate”, brak kropki na końcu i brak weryfikacji. Przeredagowanie zachowuje jeden wynik, który ma znaczenie dla klienta, i nadaje mu wartość:
Statek kosmiczny musi wznowić obrazowanie w ciągu 6 godzin od wejścia w tryb bezpieczny.
Uzasadnienie powinno mówić, skąd pochodzi 6 godzin (N1 wymaga ostrzeżeń o stresie upraw tego samego dnia, a 6.2 dopuszcza 6 godzin od transmisji do dostarczenia). Jeśli kroki wyjścia z trybu bezpiecznego mają znaczenie same w sobie, na przykład ponowne nakierowanie na Słońce lub raportowanie przyczyny, każdy z nich staje się osobnym wymaganiem. Metoda: test, przez wstrzykiwanie usterek na stanowisku flatsat; kryterium sukcesu: obrazowanie jest wznawiane w ciągu 6 godzin przy każdym wstrzykniętym wejściu w tryb bezpieczny.
3.5 Battery Thermal Control. „The thermal design shall keep the battery warm enough (TBD).” zawiera niejasne określenie, TBD w tekście i nawias. Poprawka rozdziela zobowiązanie, otwartą wartość i powód:
Projekt termiczny musi utrzymywać temperaturę ogniw akumulatora na poziomie co najmniej 0 °C podczas ładowania.
Wartość 0 °C jest przykładowa: ogniw litowo-jonowych zwykle nie ładuje się poniżej zera, ale rzeczywista granica wynika z karty katalogowej ogniwa i analizy termicznej. Dopóki ta analiza jej nie ustali, wartość jest TBR, którego właścicielem jest Thermal Engineer, z terminem przed przeglądem projektu termicznego. Przeredagowanie ujawnia też lukę, którą ukrywał oryginał: brakuje wymagania dotyczącego zakresu temperatur rozładowania, które potrzebuje własnego zapisu.
6.4 Operator Interface. „The operator interface shall be user friendly and/or easy to use.” zawiera dwa subiektywne określenia i „and/or”. Użyteczność można wyspecyfikować, ale tylko przez obserwowalne zadania:
Interfejs operatora musi umożliwiać przeszkolonemu operatorowi zarezerwowanie kontaktu ze stacją naziemną w czasie nie dłuższym niż 5 minut.
Zadanie i czas są przykładowe. Rzeczywisty zbiór wymieniałby kilka istotnych zadań (rezerwacja kontaktu, przesłanie listy celów, odczyt najnowszej telemetrii stanu), każde z czasem i limitem błędów, mierzonymi podczas demonstracji z operatorami, którzy ukończyli szkolenie.
Typowe błędy
| Błąd | Co idzie nie tak | Lepiej |
|---|---|---|
| Zapisywanie rozwiązań projektowych jako wymagań | Projekt zostaje ustalony przed analizą kompromisów, a lepsza opcja zostaje wykluczona, choć nikt o tym nie zdecydował. | Określ potrzebę („utrzymywać ogniwa w temperaturze co najmniej 0 °C podczas ładowania”) i pozwól niższemu poziomowi wybrać grzałkę. |
| Przenoszenie języka interesariuszy wprost do wymagań | „Aktualne zdjęcia dwa razy w tygodniu” to potrzeba; w tym brzmieniu nie da się jej zweryfikować. | Zachowaj potrzebę i napisz wymaganie z wartością i warunkiem, które ją zaspokaja (1.6 w ciągu 72 godzin). |
| Kilka wymagań w jednym akapicie | Jeden identyfikator niesie kilka zobowiązań, które dzielą jeden status, jeden test i jeden los. | Jedno wymaganie na element, jedno „shall” na zapis. |
| Wartości bez warunków | „30 W” na początku i na końcu okresu eksploatacji to dwa różne projekty. | Określ tryb, etap życia, środowisko i sposób uśredniania. |
| Brak uzasadnienia | Nikt nie może ocenić późniejszej zmiany, a wymaganie trwa długo po tym, jak zniknął jego powód. | Zapisz powód i liczby stojące za wartością. |
| Progi testów niewyprowadzone z wymagania | Test zostaje zaliczony, choć wymaganie nie jest spełnione (TC-06 przy 72 W mocy szczytowej wobec 28 W średnio na orbicie). | Wyprowadź kryterium sukcesu z zapisu przez obliczenie i zapisz je. |
| TBD wpisane w tekst i zapomniane | Otwarta wartość nie ma właściciela ani terminu i trafia do linii bazowej. | Śledź każde TBD i TBR z właścicielem, terminem i planem zamknięcia. |
| Nadmiarowe wymagania (gold plating) | Wymagania, o które nikt nie prosił, pochłaniają wysiłek projektowy i testowy. | Sprawdź, czy każde wymaganie najwyższego poziomu prowadzi do potrzeby lub źródła. |
| Nadmierne poleganie na automatycznych kontrolach | Czysty wynik kontroli słów zostaje uznany za poprawne wymaganie. | Używaj narzędzi do reguł mechanicznych; o poprawności, wykonalności i niezbędności decyduje człowiek. |
Wypróbuj w Holarch
W projekcie LML każde wymaganie jest encją klasy Requirement z opisanymi wyżej atrybutami: Rationale, Status, Priority, Criticality, Owner, Source, Verification Method, Verification Level, Success Criteria i polami TBD/TBR.
- Utwórz projekt demonstracyjny przez Zarządzaj projektami → Pliki projektu ▾ → Nowy projekt demonstracyjny → CubeSat (inżynieria systemów z przewodnikiem). Jego specyfikacja zawiera trzy słabe wymagania i otwarte pozycje TBD/TBR użyte w tym przewodniku.
- Otwórz Potrzeby i wymagania → Jakość, wybierz dokument na liście zakresu i kliknij Sprawdź jakość. Każde wymaganie jest oceniane według dziewięciu cech, a sugestie podają numery reguł z przewodnika INCOSE, które można sprawdzić listą słów lub wzorcem. Cechy Correct i Feasible wymagają recenzenta: kliknij znacznik, aby zapisać decyzję.
- Przeredaguj 2.5 jak powyżej i uruchom kontrolę ponownie. Ustalenia dotyczące spójnika, furtki i niejasnego określenia znikają.
- Otwórz Potrzeby i wymagania → TBD/TBR, aby zobaczyć otwarte pozycje z właścicielami i terminami, i Zamknij jedną z nich, gdy jej wartość zostanie ustalona.
- Aby uzyskać drugą opinię w sprawie cech, których reguła nie rozstrzyga, użyj ✦ AI ▾ → Kontrola wymagań przez AI; każdy werdykt i każde przeredagowanie są pokazywane do przeglądu, zanim cokolwiek się zmieni.
Pełny opis znajduje się w dokumentacji Jakość wymagań i Rejestr TBD/TBR.
Pobierz listę kontrolną
Lista kontrolna jakości wymagań z przykładami z EO-1 przed poprawką i po niej (CSV) zawiera reguły listy kontrolnej z pytaniami przeglądowymi i przykładami, do użycia podczas przeglądu lub jako punkt wyjścia dla własnych reguł pisania w projekcie. Ten sam plik oferuje przewodnik po identyfikowalności.
Pytania o pisanie wymagań
Shall, must czy will?
Działa każda konwencja, jeśli specyfikacja ją definiuje i się jej trzyma. Najbardziej rozpowszechniona używa „shall” dla wiążących wymagań, „will” dla faktów i zamiarów dotyczących rzeczy spoza systemu, a „should” dla celów, które nie są weryfikowane. Niektóre rządowe poradniki stylu wolą „must” ze względu na prosty język. Prawdziwym problemem jest mieszanie ich w jednej specyfikacji.
Ile wymagań powinien mieć system?
Nie ma właściwej liczby. Mały statek kosmiczny może mieć kilkadziesiąt wymagań systemowych i kilkaset pod nimi; duży program ma ich tysiące. Bardziej przydatne pytania to, czy każde wymaganie prowadzi do potrzeby lub elementu nadrzędnego i czy każda potrzeba ma pod sobą wymagania.
Czy historyjki użytkownika są wymaganiami?
Historyjka użytkownika zapisuje potrzebę i jej cel słowami użytkownika. Pełni rolę potrzeby interesariusza, a jej kryteria akceptacji są bliskie kryteriom weryfikacji. W przypadku systemu, który jest budowany, integrowany i weryfikowany jako sprzęt i oprogramowanie razem, historyjki nadal trzeba przekształcić w wymagania, które można alokować i testować.
Czy narzędzie może sprawdzić jakość wymagań?
Narzędzie może niezawodnie sprawdzać reguły mechaniczne: czasowniki modalne, spójniki, niejasne słowa, furtki, zaimki, brakujące powiązania. Nie może wiedzieć, czy 30 W to właściwa wartość ani czy panele mogą ją dostarczyć. Użyj automatycznej kontroli, aby usunąć ustalenia mechaniczne przed przeglądem, dzięki czemu recenzenci poświęcą czas poprawności i wykonalności.
Co dalej
- Identyfikowalność wymagań i wpływ zmian: powiąż te wymagania z potrzebami, projektem i testami i śledź zmianę.
- Analiza funkcjonalna: przekształć wymagania w funkcje i alokuj je.
- Macierz weryfikacji wymagań: zaplanuj metodę weryfikacji każdego wymagania i zapisz wyniki.
- Potrzeby i wymagania w Holarch: dokumenty, kontrole jakości, linie bazowe i identyfikowalność w jednym modelu.