Holarch

Wymagania

Generowanie dokumentów

Umieszczaj w dokumentach żywe macierze identyfikowalności, weryfikacji i interfejsów oraz raporty z testów, eksportuj je w czterech formatach, twórz je z linii bazowej i oznaczaj: informacja firmowa, oświadczenie o dystrybucji DoD, informacja o kontroli eksportu, prawa autorskie lub numer umowy na każdej stronie i w każdym eksporcie.

Jak z niego korzystać →

Na tej stronie
  1. Przegląd
  2. Pojęcia
    1. Macierze
    2. Dynamiczne, nie kopiowane
  3. Jak z niego korzystać
    1. Wstawianie macierzy do dokumentu
    2. Eksport macierzy
    3. Macierze z linii bazowej
    4. Raporty z testów
    5. Oznaczanie dokumentów i eksportów
    6. Ustawianie oznaczenia projektu
    7. Ustawianie oznaczenia organizacji
    8. Własne oznaczenie, strona tytułowa i numery stron dokumentu
    9. Gdzie drukowane są oznaczenia
  4. Kontrole modelu
  5. Wskazówki

Przegląd

Holarch tworzy produkty dostarczane z modelu, więc dokument zawsze odpowiada wymaganiom, testom i powiązaniom, które za nim stoją. Trzy narzędzia obejmują to, o co zwykle proszą recenzenci:

  • Bloki macierzy: macierz identyfikowalności, weryfikacji lub interfejsów albo raport z testów w tekście dokumentu, aktualizowane przy każdej zmianie modelu.
  • Eksportuj macierz: te same macierze i raport z testów jako osobny plik Excel, Word, CSV lub strona internetowa, z bieżącego modelu lub z linii bazowej.
  • Oznaczenia i Ustawienia strony: oznaczenie organizacji, projektu lub jednego dokumentu (informacja firmy, klauzula dystrybucyjna, informacja o kontroli eksportu, prawa autorskie lub numer umowy) w każdym eksporcie, a także strona tytułowa i numery stron w plikach Word.

Wartości dynamiczne i tabele w tekście opisuje strona Dokumenty: Wartość dynamiczna… wstawia jeden atrybut encji, Liczba lub suma… – liczbę obliczoną z zapytania, Tabela dynamiczna… – tabelę z zapytania, a Odsyłacz… – bieżący numer sekcji, rysunku lub tabeli.

Pojęcia

Macierze

MacierzWierszeKolumnyWyróżniane jako luka
RTM (macierz identyfikowalności wymagań)WymaganiaNumber, Requirement, Parent, Traced From, Traced To, Satisfied ByWymaganie bez elementu nadrzędnego i bez niczego, z czego jest śledzone
Macierz kaskadowania wymagańWymaganiaNumber, Requirement, Flows Down From, Flows Down To, Derived RequirementsWymaganie najwyższego poziomu bez elementu podrzędnego i bez wymagania pochodnego
Macierz alokacji wymagańWymaganiaNumber, Requirement, Components, Functions, OtherWymaganie, którego nic nie spełnia
Macierz zgodności (pokazywana, gdy włączony jest program formalny)Wymagania specyfikacji klientaNumber, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/WaiverWymaganie bez deklaracji zgodności (Nieocenione)
RVTM (macierz identyfikowalności weryfikacji wymagań)WymaganiaNumber, Requirement, Method, Level, Verified By, StatusBrak metody weryfikacji lub brak weryfikującego przypadku testowego
VCRM (macierz odsyłaczy weryfikacji)WymaganiaNumber, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, StatusNie wybrano metody weryfikacji
VCRM według poziomu weryfikacjiWymaganiaNumber, Requirement, następnie I, A, D i T pod każdym poziomem weryfikacji, Verified By, StatusBrak metody weryfikacji lub brak poziomu weryfikacji
Raport z testówPrzypadki testowe cyklu testówNumber, Test Case, Verifies, Status, Actual Result, RunPrzypadek testowy, który nie zakończył się powodzeniem w cyklu
Macierz alokacjiFunkcje (Actions)Number, Function, Performed ByFunkcja, której nie wykonuje żaden komponent
Macierz interfejsówKomponenty (Assets)Te same komponenty; komórka wymienia elementy Conduit od komponentu wiersza do komponentu kolumnyKomponent bez elementu Conduit do pozostałych lub od nich
Macierz N²Funkcje (Actions)Te same funkcje; komórka wymienia elementy Input/Output, które funkcja wiersza generuje, a funkcja kolumny odbieraFunkcja, która nie wymienia żadnego wejścia ani wyjścia
Macierz niestandardowaEncje z zapytania wyszukiwaniaEncje z drugiego zapytania; komórka podaje relacje między nimi lub pokazuje X dla jednej wybranej relacjiWiersz bez relacji z żadną kolumną
  • Parent to wymaganie, które wiersz dekomponuje. Traced From, Traced To i Satisfied By wymieniają powiązane encje. W macierzy kaskadowania Derived Requirements to wymagania, do których wiersz jest śledzony (traces to).
  • W VCRM X oznacza każdą zaplanowaną metodę; Status to dotychczasowy wynik weryfikacji, agregowany z przypadków testowych tak jak w Centrum testów.
  • W VCRM według poziomu weryfikacji kolumny są pogrupowane według poziomów atrybutu Verification Level (Component, Subsystem, System). X stoi pod poziomem wymagania i każdą z jego zaplanowanych metod.
  • Przypadki testowe nigdy nie są wymieniane jako funkcje: macierze alokacji i N² pokazują elementy Action, które nie są elementami Test Case.
  • Zakres: macierz obejmuje encje jednego dokumentu (w kolejności i numeracji dokumentu), wszystkie części kompilacji lub cały projekt. Macierz alokacji używa funkcji dokumentu albo wszystkich funkcji, gdy dokument ich nie ma. Macierze interfejsów i N² mogą też obejmować elementy podrzędne jednego elementu Asset lub Action, tak jak diagramy I² i N²; dla całego projektu wymieniają komponenty lub funkcje, które mają element Conduit lub Input/Output, maksymalnie 120. Macierz niestandardowa pokazuje do 2000 wierszy i 120 kolumn.
  • Blok Raport z testów pokazuje jeden cykl testów jednego zestawu testów lub jego bieżące wyniki. Zobacz Raporty z testów.

Dynamiczne, nie kopiowane

Blok macierzy przechowuje tylko to, co ma pokazać, a nie wiersze. Przy każdym wyświetleniu lub eksporcie dokumentu Holarch odbudowuje wiersze z modelu. Wynik jest buforowany do następnej zmiany, więc duże projekty działają szybko.

Jak z niego korzystać

Wstawianie macierzy do dokumentu

  1. Otwórz dokument i kliknij w opis dokumentu lub elementu.
  2. Na pasku narzędzi tekstu sformatowanego otwórz + i wybierz Macierz….
  3. Wybierz Macierz i Zakres. Zakres początkowo wskazuje otwarty dokument.
    • Dla Macierz niestandardowa wpisz zapytania wyszukiwania Wiersze i Kolumny (np. class:Requirement i class:Asset), wybierz Relacja lub pozostaw Dowolna relacja i, jeśli chcesz, nadaj jej Tytuł.
    • Dla Raport z testów wybierz Zestaw testów i Cykl testów albo Bieżące wyniki.

      Pojawia się podgląd. Aktualizuje się przy każdej zmianie modelu.

  4. Kliknij Wstaw.

    Macierz pojawia się w tekście z przerywanym obramowaniem. Jej podpis podaje nazwę macierzy, zakres i liczbę wierszy z lukami.

Macierzy nie można edytować komórka po komórce; zamiast tego zmień model. Aby ją usunąć, usuń tabelę w edytorze jak każdą inną zawartość.

Eksport macierzy

  1. W dokumencie otwórz Dostarcz ▾ i wybierz Macierz identyfikowalności…. Możesz też wybrać Dostarcz ▾ → Wszystkie eksporty… i wskazać Macierz identyfikowalności (Excel), (Word), (CSV) lub (HTML).
  2. W oknie Eksportuj macierz wybierz Macierz i Zakres, a w polu Eksportuj jako wybierz Macierz (Excel), Macierz (Word), Macierz (CSV) lub Macierz (HTML).
  3. Opcjonalnie: w polu Model wybierz linię bazową zamiast Bieżący model. Lista pokazuje linie bazowe projektu i wybranego dokumentu.

    Wiersz pod polami podaje liczbę wierszy i liczbę wierszy z lukami.

  4. Kliknij Eksportuj.

    Powiadomienie brzmi “Wyeksportowano macierz.” Luki są zacieniowane na czerwono w plikach Excel, Word i na stronie internetowej. Eksporty Word i do strony internetowej używają Ustawień strony dokumentu. W pliku Word kolumny tekstowe są szerokie, a kolumny metod weryfikacji wąskie, z nagłówkami I, A, D i T oraz legendą pod tabelą (I = Inspection, A = Analysis, D = Demonstration, T = Test). Macierze z więcej niż pięcioma kolumnami używają strony w orientacji poziomej. VCRM według poziomu ma drugi wiersz nagłówka z poziomami; macierze interfejsów, N² i niestandardowe cieniują nagłówki wierszy i przekątną.

Macierze z linii bazowej

Podpisany produkt dostarczany musi pokazywać model w stanie z linii bazowej, a nie w dzisiejszym. Macierz utworzona z linii bazowej używa encji i relacji linii bazowej, a jej tytuł kończy się na “(linia bazowa nazwa)”.

  • Eksportuj macierz: wybierz linię bazową w polu Model.
  • Linia bazowa projektu zawiera cały model, więc każda macierz działa na jej podstawie.
  • Linia bazowa dokumentu zawiera dokument, jego elementy i powiązane z nimi encje. Macierze tego dokumentu są kompletne. Macierz, która wychodzi poza dokument (cały projekt albo macierz interfejsów lub N²), ma uwagę “Utworzono z linii bazowej dokumentu, która zawiera tylko ten dokument i powiązane z nim encje.”

Raporty z testów

Raport z testów podaje wyniki jednego cyklu testów: co testowano, w jakiej konfiguracji, co zakończyło się powodzeniem, a co niepowodzeniem, oraz które wymagania to weryfikuje.

  1. W Centrum testów zarejestruj cykl testów poleceniem Rozpocznij nowy cykl…. Wpisz Konfiguracja / kompilacja i Obiekt testu (oba pola zaczynają od wartości najczęściej zapisywanych w przebiegu).
  2. Na karcie zestawu otwórz ⋯ i wybierz Raport z testów…. Możesz też otworzyć ⋯ → Cykle testów… i kliknąć Raport… przy cyklu.
  3. W oknie Eksportuj raport z testów wybierz Cykl testów, a w polu Eksportuj jako – Raport z testów (Word), (Excel), (CSV) lub (HTML), a następnie kliknij Eksportuj.

Raport Word (domyślny) ma następujące sekcje:

  1. Identification: zestaw testów, cykl testów, kiedy zapisano wyniki i kiedy utworzono raport.
  2. Test Environment and Configuration: konfiguracja lub kompilacja, obiekt testu, testerzy i daty przebiegów.
  3. Summary of Results: liczby według statusu i odsetek powodzeń.
  4. Results by Test Case: jeden wiersz na przypadek testowy.
  5. Detailed Results: dla każdego przypadku testowego wynik oczekiwany i rzeczywisty, tester, data, konfiguracja, obiekt testu, plik dowodowy i wyniki kroków.
  6. Deviations and Open Issues: przypadki testowe zakończone niepowodzeniem i zablokowane wraz z powiązanymi elementami Issue.
  7. Test Evidence: pliki dowodowe zapisane w cyklu.
  8. Requirement Verification Status: wymagania weryfikowane przez zestaw, ze statusem z wyników tego cyklu.

Excel zawiera trzy arkusze (Results, Steps, Requirements); CSV i strona internetowa zawierają tabelę wyników. Wyniki pochodzą z cyklu w zapisanej postaci, więc raport pozostaje taki sam po zresetowaniu zestawu. Nazwy, zweryfikowane wymagania i elementy Issue pochodzą z bieżącego modelu. Cykle zapisane, zanim zaczęto przechowywać wyniki kroków i dowody, pokazują te pola jako “—”.

Aby umieścić tabelę wyników w dokumencie, wstaw blok macierzy Raport z testów (zobacz wyżej).

Oznaczanie dokumentów i eksportów

Oznaczenie to tekst, który Holarch drukuje na wszystkim, co eksportujesz: nagłówek u góry każdej strony, stopka u dołu każdej strony i informacja na pierwszej stronie. Ustaw je raz dla projektu lub organizacji, a każdy eksport będzie je zawierał. Dokument może je zastąpić własnym.

Uwaga: usługa hostowana (app.holarch.app) nie może przechowywać informacji CUI, niejawnych ani podlegających kontroli eksportu (Warunki korzystania). Lista standardowa pomija tam klauzule Distribution Statement B do F i informację o kontroli eksportu, a oznaczenie, które wymienia CUI, poziom klauzuli tajności (np. SECRET//NOFORN), ITAR, EAR lub kontrolę eksportu albo Distribution Statement B do F, nie zostanie zapisane: “Usługa hostowana Holarch nie może przechowywać informacji CUI, niejawnych ani podlegających kontroli eksportu, więc tego oznaczenia nie można tu użyć. Usuń je lub użyj aplikacji desktopowej albo instalacji samodzielnie hostowanej.” Informacje firmy, takie jak Company Confidential, Distribution Statement A, prawa autorskie i numery umów, pozostają dostępne. Oznaczenia ustawione przed wprowadzeniem tej zasady są zachowywane i nadal drukowane; aby je zmienić, usuń część objętą ograniczeniem.

Aplikacja desktopowa i instalacje samodzielnie hostowane oferują pełną listę i przyjmują dowolne oznaczenie. Oznaczenia to wybrany przez Ciebie tekst; Holarch je drukuje, ale nie egzekwuje zasad postępowania, a obowiązują własne kontrole organizacji. W każdej edycji informacja o kontroli eksportu w oznaczeniu wyłącza AI dla projektu.

Lista Standardowe oznaczenie wypełnia tekst za Ciebie:

Standardowe oznaczenieNagłówekStopkaInformacja
Własność firmyCOMPANY PROPRIETARYCOMPANY PROPRIETARYInformacja o własności, która wymienia pole Firma
Poufne firmyCOMPANY CONFIDENTIALCOMPANY CONFIDENTIALInformacja o poufności, która wymienia pole Firma
Distribution Statement A do F (B do F: tylko aplikacja desktopowa i instalacje samodzielnie hostowane)(brak)DISTRIBUTION STATEMENT A to FStandardowe brzmienie klauzuli DoD (DoDI 5230.24) z wypełnionymi polami Powód, Data ustalenia i Biuro nadzorujące
Informacja o kontroli eksportu (ITAR/EAR) (tylko aplikacja desktopowa i instalacje samodzielnie hostowane)(brak)Export-controlled technical data. See the notice on the first page.Ostrzeżenie, że dokument może zawierać dane techniczne podlegające ITAR (22 CFR 120–130) lub EAR (15 CFR 730–774)
Prawa autorskie(brak)© Rok Właściciel praw autorskich. All rights reserved.(brak)
Numer umowy(brak)Contract No. Numer umowy(brak)

Pole do wypełnienia pozostawione puste zostaje w tekście jako symbol zastępczy w nawiasach kwadratowych, np. [reason]. Edytor pokazuje wtedy “Przed eksportem uzupełnij części w nawiasach.”

Ustawianie oznaczenia projektu

  1. Naciśnij ⌘K / Ctrl+K i wybierz Oznaczenie projektu…. Można je też otworzyć z Ustawienia strony… w dokumencie lub z Preferencje projektu… (Strona główna ▾ na stronie głównej) otwartego projektu.
  2. Wybierz Własne oznaczenie.
  3. W polu Standardowe oznaczenie wybierz pozycję, wypełnij jej pola (np. Firma) i kliknij Dodaj do oznaczenia.

    Pola Nagłówek, Stopka i Informacja są wypełnione. Dodaj kolejną pozycję, aby je połączyć: nagłówki i stopki są łączone znakiem “ · ”, a każda informacja staje się osobnym akapitem.

  4. W razie potrzeby edytuj tekst, a następnie kliknij Zapisz.

    Powiadomienie brzmi “Zapisano oznaczenie projektu.” Oznaczenie projektu zmieniają tylko właściciele projektu; pozostali członkowie widzą je tylko do odczytu.

Wyczyść opróżnia trzy pola. Brak oznaczenia wyłącza oznaczenie dla projektu, także gdy organizacja ma swoje.

Ustawianie oznaczenia organizacji

  1. Otwórz menu konta i wybierz Ustawienia organizacji, a następnie otwórz organizację.
  2. W sekcji Oznaczenie dokumentu kliknij Edytuj oznaczenie….
  3. Ustaw oznaczenie tak jak dla projektu i kliknij Zapisz.

    Powiadomienie brzmi “Zapisano oznaczenie organizacji.” Dotyczy ono każdego projektu organizacji, który nie ma własnego oznaczenia. Zmieniają je tylko administratorzy organizacji.

Własne oznaczenie, strona tytułowa i numery stron dokumentu

  1. W dokumencie otwórz Dostarcz ▾ i wybierz Ustawienia strony….
  2. W sekcji Oznaczenie wybierz jedną opcję:
    • Oznaczenie projektu lub organizacji (domyślnie): wiersz poniżej podaje oznaczenie, którego używa dokument.
    • Własne oznaczenie: ustaw nagłówek, stopkę i informację tak jak dla projektu.
    • Brak oznaczenia: dokument i jego eksporty nie mają żadnego oznaczenia.
  3. Wypełnij resztę:
    • Strona tytułowa z polami Wersja i Opracował(a). Strona tytułowa pokazuje też informację.
    • Numery stron (“Strona X z Y”) w eksportach do Worda.
  4. Kliknij Zastosuj.

    Powiadomienie brzmi “Zapisano ustawienia strony.” Nagłówek i stopka pojawiają się u góry i u dołu dokumentu, a informacja pod jego tytułem. ⌘Z / Ctrl+Z cofa zmianę w jednym kroku.

Obowiązuje najbliższe oznaczenie: własne oznaczenie dokumentu, w przeciwnym razie projektu, a w przeciwnym razie organizacji.

Gdzie drukowane są oznaczenia

  • Widok dokumentu i Drukuj lub PDF…: nagłówek i stopka u góry i u dołu każdej strony, informacja pod tytułem.
  • Eksport do Worda (Dostarcz ▾ → {template} (Word) lub Dokument (Word) w oknie Wszystkie eksporty…): nagłówek i stopka powtarzają się na każdej stronie, z numerami stron, jeśli je wybrano, a strona tytułowa zastępuje zwykły tytuł. Dynamiczny blok macierzy w dokumencie staje się tabelą Word z tytułem nad nią, z tymi samymi szerokościami kolumn i nagłówkami I/A/D/T oraz lukami zacieniowanymi na czerwono.
  • Eksportuj macierz oraz Macierz identyfikowalności (Word) lub (HTML).
  • Inne pliki Word: dokument ICD, prezentacja, diagram i eksporty Rozbicie (Word) mają nagłówek i stopkę na każdej stronie oraz informację pod tytułem.
  • Raporty Excel: nagłówek i stopka trafiają do nagłówka i stopki strony każdego arkusza, które Excel pokazuje w widoku Układ strony i drukuje.
  • CSV: tylko gdy zaznaczysz Oznaczenie jako pierwszy wiersz w eksporcie Tabela (CSV). Domyślnie opcja jest wyłączona, więc plik można ponownie zaimportować bez zmian.
  • Obrazy diagramów: eksporty PNG i SVG otrzymują pasek nad diagramem z nagłówkiem i pasek pod nim ze stopką i informacją. Eksporty Strona internetowa (HTML) pokazują je u góry i u dołu strony. Miniatury i obrazy diagramów wewnątrz dokumentów pozostają bez oznaczeń.
  • Prezentacje: slajdy PowerPoint, strony internetowej, PNG i SVG pokazują nagłówek i stopkę na każdym slajdzie oraz informację na pierwszym slajdzie.
  • Kompilacja ma własne Ustawienia strony, używane przy eksporcie kompilacji.

Kontrole modelu

Kontrole modelu zgłaszają wartość dynamiczną lub tabelę dynamiczną, która wskazuje coś usuniętego (reguła Global.7, “Wartości dynamiczne wskazujące brakujące cele”):

  • Wartość dynamiczna, której encję usunięto, pokazuje “{Entity: … Not found}”.
  • Blok macierzy, którego dokument zakresu usunięto, blok Raport z testów, którego zestaw testów lub cykl testów usunięto, albo Macierz niestandardowa, której relacja już nie istnieje.
  • Liczba lub suma albo Tabela dynamiczna, której zapytanie wymienia nieistniejącą klasę, etykietę, relację lub dokument.
  • Odsyłacz, którego element, rysunek lub tabelę usunięto.

Otwórz opis, a następnie edytuj lub usuń wartość dynamiczną albo wstaw ją ponownie dla istniejącego celu. Zobacz Kontrole modelu.

Wskazówki

  • Umieść RVTM lub VCRM na końcu specyfikacji jako jej sekcję weryfikacji; pozostaje aktualna aż do przeglądu.
  • Dla pakietu przeglądu utwórz kompilację i nadaj jej stronę tytułową oraz oznaczenie we własnych Ustawieniach strony.
  • Wyeksportuj VCRM do Excela dla komisji przeglądowej, która nanosi na nim uwagi, a dynamiczny blok zachowaj w dokumencie.
  • Dla planu weryfikacji zorganizowanego według poziomów integracji użyj VCRM według poziomu weryfikacji i najpierw ustaw Verification Level każdego wymagania.
  • Dla dokumentu kontroli interfejsów wstaw Macierz interfejsów z zakresem ograniczonym do systemowego elementu Asset, aby jego elementy podrzędne i ich elementy Conduit pojawiły się na przekątnej i w komórkach.