Holarch

Wymagania

Dokumenty

Pisz, porządkuj, numeruj, umieszczaj w liniach bazowych i publikuj specyfikacje jako żywe widoki modelu, z szablonami, tekstem sformatowanym, raportami i wyjściem do Worda.

Jak z niego korzystać →

Na tej stronie
  1. Przegląd
  2. Pojęcia
    1. Co sprawia, że coś jest dokumentem
    2. Typy dokumentów
    3. Liczby
    4. Linie bazowe
  3. Jak z niego korzystać
    1. Kiedy i dlaczego
    2. Tworzenie specyfikacji wymagań z szablonu
    3. Pisanie wymagań
    4. Szybkie dodawanie wielu wymagań
    5. Zmiana struktury
    6. Przegląd, linia bazowa i publikacja
    7. Przykład: demo CubeSat EO-1
    8. Wskazówki i dobre praktyki
    9. Typowe błędy
    10. Powiązania z innymi funkcjami
  4. Lista dokumentów
  5. Strona dokumentu
    1. Nagłówek strony
    2. Pasek narzędzi
    3. Panel konspektu
    4. Treść dokumentu
    5. Menu kontekstowe
    6. Szybkie dodawanie
    7. Inspektor
  6. Dodawanie elementów
    1. Nowe elementy
    2. Inne klasy
    3. Dokumenty strukturalne z nagłówkami
    4. Istniejące encje
  7. Zmiana struktury
    1. Wcięcie, zmniejszenie wcięcia i przenoszenie
    2. Przeciąganie i upuszczanie
    3. Przenoszenie pod element
  8. Numeracja
    1. Automatyczna zmiana numeracji
    2. Reguły następnego numeru
    3. Zmiana numeracji
    4. Numeracja dokumentu (numery meta)
  9. Szablony
    1. Szablony wbudowane
    2. Zapisywanie dokumentu jako szablonu
    3. Zarządzanie szablonami
    4. Szablony zapisane w tej przeglądarce
    5. Stosowanie szablonu do istniejącego dokumentu
  10. Edytor tekstu sformatowanego
    1. Pasek narzędzi
    2. Tabele
    3. Obrazy i pliki
    4. Tekst alternatywny
    5. Łącza i łącza osadzone
    6. Treść dynamiczna
    7. Narzędzia tekstowe AI
    8. Wklejanie
    9. Skróty edytora tekstu sformatowanego
  11. Wyszukiwanie w dokumencie
  12. Znajdowanie i zastępowanie
  13. Menu Pisz
    1. Ustawianie atrybutu w tej gałęzi
    2. Podział na kilka elementów
  14. Menu Sprawdź
    1. Status śledzenia
    2. Znajdowanie akronimów
  15. Menu Dostarcz
    1. Szablony Word
    2. Firmowe pliki Word
  16. Menu Widok
  17. Linie bazowe
    1. Tworzenie linii bazowej
    2. Wyświetlanie linii bazowej
    3. Porównywanie wersji
  18. Raporty
  19. Wynik Word
    1. Podpisy, spisy i odsyłacze
    2. Ustawienia produktu dostarczanego
    3. Format strony
    4. Konwersja tekstu sformatowanego
    5. Zmiany śledzone
    6. Drukowanie / PDF
  20. Komentarze
  21. Kompilacje
    1. Sekcje generowane
    2. Kompilacja w Wordzie
  22. Narzędzia AI
  23. Skróty klawiszowe
  24. Ustawienia zapamiętywane w tej przeglądarce
  25. Komunikaty
  26. Limity
  27. Powiązane

Przegląd

Dokument to specyfikacja, plan lub procedura, których sekcje i wymagania są encjami w modelu. Strona dokumentu służy do ich pisania, zmiany struktury, numerowania, obejmowania linią bazową i publikowania do Worda, Excela, ReqIF, Markdown i innych formatów.

Każdy element dokumentu jest encją. Dlatego to samo wymaganie pojawia się też w Bazie danych, na diagramach, w Macierzy identyfikowalności i w kontroli jakości. Edycja w którymkolwiek z tych miejsc jest widoczna w dokumencie.

Pojęcia

Co sprawia, że coś jest dokumentem

  • Dokument to encja Artifact spełniająca jeden z dwóch warunków:
    • Ma etykietę typu dokumentu: dowolną etykietę, której nazwa kończy się na “Document”.
    • Jest source of co najmniej jednego obiektu Statement lub Heading.
  • Jego elementy najwyższego poziomu to encje, dla których dokument jest source of. Głębsze elementy zwisają pod nimi przez relacje decomposed by. Widoczny konspekt jest tym drzewem dekompozycji.
  • Elementy to zwykle obiekty Statement (sekcje, nagłówki, uwagi, założenia) i Requirement (oraz ich podklasy). Dowolną inną klasę dodaje się przez Inna klasa….
  • Heading (dokumenty strukturalne LML 2.0) to sekcje zawierające elementy dowolnej klasy. Podsekcja to Heading pod Heading (decomposed by). Każdy inny element pod Heading jest treścią sekcji: Heading go contains, element zachowuje własny numer i jest wymieniany przed podsekcjami. Zobacz Dokumenty strukturalne z nagłówkami.
  • Usunięcie elementu z dokumentu nie usuwa encji. Robi to usunięcie go z Bazy danych.

Typy dokumentów

Typem jest etykieta typu dokumentu. Decyduje ona, które szablony są oferowane jako pierwsze i czy dokument otwiera się w trybie Papier.

TypSzablony wbudowane
Requirements DocumentSpecyfikacja wymagań; specyfikacja wymagań interesariuszy (StRS); specyfikacja wymagań systemowych (SyRS); specyfikacja wymagań oprogramowania (SRS); specyfikacja wymagań interfejsów (IRS)
Interface Control DocumentDokument kontroli interfejsów (ICD)
Concept of Operations DocumentKoncepcja operacji
Needs Analysis DocumentAnaliza potrzeb
Concept Exploration DocumentEksploracja koncepcji; raport z analizy kompromisów
Concept Definition DocumentDefinicja koncepcji; opis architektury
Systems Engineering Management Plan DocumentPlan zarządzania inżynierią systemów
Test Plan DocumentPlan testów; plan weryfikacji i walidacji; procedura testowa; raport z testów
Independent Verification & Validation Plan DocumentPlan IV&V
Project Management Plan DocumentPlan zarządzania projektem; plan zarządzania ryzykiem; plan zarządzania konfiguracją
Integrated Logistics Support Plan DocumentPlan zintegrowanego wsparcia logistycznego
Standard Operating Procedure DocumentStandardowa procedura operacyjna

Szablony innych typów są wymienione w sekcji Inne szablony, więc każdy szablon może rozpocząć dowolny dokument.

Aby dodać typ dokumentu, dodaj do klasy Artifact etykietę, której nazwa kończy się na “Document” (zobacz Rozszerzenia schematu). Dokument z etykietą Pakiet przeglądu zestawia inne dokumenty; zobacz Kompilacje.

Liczby

Każdy element ma numer, np. 3.2, pokazywany przed jego nazwą. Numery są zapisywane w encji, więc to samo wymaganie ma wszędzie ten sam numer. Wyjątkiem jest numeracja dokumentu, która przechowuje osobne numery dla każdego dokumentu.

Holarch utrzymuje kolejność numerów, dopóki włączone jest Numeruj ponownie automatycznie po dodaniu lub przeniesieniu elementów (domyślnie; pole wyboru jest w Pisz ▾ → Numeruj ponownie…).

Linie bazowe

Linia bazowa to migawka dokumentu tylko do odczytu. Zawiera:

  • Elementy dokumentu, ich atrybuty i relacje, w tym powiązania z encjami o jeden krok poza dokumentem.
  • Ustawienia dokumentu.
  • Datowane zapisy zatwierdzeń, których nie można później edytować.

Linie bazowe zasilają raporty zmian oraz tabele Revision History i Approvals w wyniku Word.

W usłudze hostowanej:

  • Każdy zapis zatwierdzenia otrzymuje czas serwera i konto, które go zapisało, a nie zegar przeglądarki. Zapis pokazuje “(czas serwera) · zarejestrował(a) {name}”, a zapis trafia do dziennika audytu.
  • Tylko właściciele projektu mogą zmieniać nazwę linii bazowej lub ją usuwać. Dla pozostałych Usuń i pole nazwy są wyszarzone z komunikatem “Tylko właściciel projektu może zmienić nazwę linii bazowej lub ją usunąć.” Przywracanie działa jak dotychczas.

W aplikacji komputerowej zapisy mają datę, z jaką zapisał je Twój komputer.

Jak z niego korzystać

Kiedy i dlaczego

Używaj dokumentu, gdy produktem dostarczanym jest specyfikacja, którą ktoś przeczyta, przejrzy i podpisze. Przykłady:

  • Specyfikacja wymagań systemowych na SRR.
  • Koncepcja operacji na wczesnym etapie opracowywania koncepcji.
  • Plan testów przed rozpoczęciem weryfikacji.
  • Procedura operacyjna.

Pisz tu wymagania, a następnie śledź ich powiązania z funkcjami, zasobami i testami w innych miejscach modelu. Dokument odpowiada na pytanie “Co mówi ta specyfikacja, w jakiej kolejności i co się zmieniło od jej zatwierdzenia?”

W przebiegu inżynierii systemów dokumenty są pierwsze: potrzeby interesariuszy i wymagania systemowe. Zasilają analizę funkcjonalną i alokację. Na przeglądach wracają jako objęte linią bazową, zatwierdzone wyniki z raportami identyfikowalności.

Tworzenie specyfikacji wymagań z szablonu

  1. Na pasku nawigacji otwórz Potrzeby i wymagania → Dokumenty.
  2. Kliknij + Nowy dokument w nagłówku strony.

    Otwiera się Nowy dokument.

  3. Wpisz Nazwa (wymagane). Numer i opis można dodać później w inspektorze.
  4. W sekcji Szablon pole Szablony dla pokazuje szablony jednego typu dokumentu, np. Requirements Document. Każda karta pokazuje pierwsze sekcje jako podgląd. Wybierz jedną z opcji:
    • Pusty: pusty dokument pokazanego typu.
    • Pozycję z Szablony organizacji (serwery Holarch, hostowane lub samodzielnie utrzymywane), opublikowaną przez administratorów Twojej organizacji. Domyślny szablon organizacji dla danego typu jest wstępnie wybrany.
    • Pozycję z Szablony projektu, zapisaną w tym projekcie.
    • Pozycję z Szablony wbudowane.
    • Szablon innego typu dokumentu w sekcji Inne szablony.

      Dokument otrzymuje typ wybranego szablonu.

  5. Zaznacz Uwzględnij wskazówki redakcyjne, aby dodać krótki przewodnik pisania do każdej sekcji szablonu wbudowanego.
  6. Kliknij Utwórz.

    Dokument otwiera się z numerowanymi sekcjami szablonu, np. 1 Document Control, 1.1 Revision History, 1.2 Approvals, 2 Introduction … Jeśli dodano wskazówki redakcyjne, usuwaj je, pisząc kolejne sekcje.

Pisanie wymagań

  1. Kliknij wiersz sekcji, aby go zaznaczyć.
  2. Kliknij + Podrzędny lub naciśnij ⌥⌘↵ / Ctrl+Alt↵.

    Pojawia się nowy wiersz o nazwie “New Requirement” z numerem, a jego nazwa jest gotowa do wpisania.

  3. Wpisz nazwę i naciśnij Enter.
  4. Kliknij opis i napisz stwierdzenie ze słowem “shall”.
  5. Naciśnij ⌘↵ / Ctrl↵ lub kliknij gdzie indziej, aby zapisać opis.
  6. Aby dodać następne wymaganie na tym samym poziomie, ponownie naciśnij ⌘↵ / Ctrl↵.

+ Nowy … (nagłówek strony) dodaje element na końcu dokumentu; + Po i + Podrzędny dodają go obok zaznaczonego elementu (mówi o tym podpowiedź + Nowy …). Wszystkie trzy dodają ostatnią klasę wybraną z ich menu ▾ (domyślnie Requirement). Ta przeglądarka zapamiętuje wybór.

Szybkie dodawanie wielu wymagań

Użyj Szybkie dodawanie u dołu dokumentu, aby wpisywać wymagania jedno po drugim.

  1. Na pasku Szybkie dodawanie wybierz sekcję, np. Pod 4 Command and Data Handling.
  2. Wpisz tekst wymagania.
  3. Naciśnij Enter.

    Holarch dodaje wymaganie i nadaje mu nazwę ze słów po “shall”. Kursor pozostaje w polu dla następnego.

Zmiana struktury

Zmieniaj konspekt klawiszami, przeciąganiem lub z menu kontekstowego. Przy włączonej automatycznej zmianie numeracji numery aktualizują się po każdym przeniesieniu.

  • Klawiszami: zaznacz wiersz, a następnie naciśnij:
    • ⌥⇧→ / Alt+Shift+→, aby wciąć go pod element powyżej.
    • ⌥⇧← / Alt+Shift+←, aby zmniejszyć jego wcięcie.
    • ⌥ / Alt+↑ lub ⌥ / Alt+↓, aby przesunąć go między elementami równorzędnymi.
    • Tab nie służy do wcinania, więc zawsze przechodzi do następnego pola.
  • Przeciąganiem: przeciągaj wiersze w panelu Konspekt. Upuść na górnej lub dolnej krawędzi wiersza, aby umieścić element przed nim lub za nim. Upuść na środku, aby uczynić go elementem podrzędnym.
  • Z menu: kliknij wiersz prawym przyciskiem myszy, wybierz Przenieś pod ▸, a następnie wybierz nowy element nadrzędny z listy (wpisz tekst, aby ją przefiltrować). Elementy podrzędne przenoszą się razem z nim.

Przegląd, linia bazowa i publikacja

  1. Wybierz Sprawdź ▾ → Sprawdź jakość i popraw słabe wymagania (zobacz Wymagania).
  2. Wybierz Sprawdź ▾ → Status śledzenia… i powiąż wymagania, które nie są jeszcze alokowane ani zweryfikowane.
  3. Zamknij otwarte kwestie w Sprawdź ▾ → Rejestr TBD/TBR.
  4. Przejrzyj Sprawdź ▾ → Powiązania do przeglądu.
  5. W tabliczce tytułowej kliknij Wersja ▾ i wybierz Zapisz linię bazową….
  6. Wpisz nazwę, np. “SRR Baseline”.
  7. Dodaj jeden wiersz zatwierdzenia dla każdego zatwierdzającego, z imieniem i nazwiskiem, rolą i oświadczeniem.
  8. Kliknij Utwórz.

    Linia bazowa pojawia się w Wersja ▾, a przycisk wskazuje ją jako ostatnią linię bazową.

  9. Kliknij Dostarcz ▾ → Specyfikacja (Word).

    Plik Word zostaje pobrany z opcjami szablonu Specyfikacja, w tym z tabelami Revision History i Approvals wypełnionymi na podstawie linii bazowych.

  10. Otwórz plik w Wordzie i zaakceptuj monit o aktualizację pól.

    Spis treści zostaje wypełniony.

Aby dokument został przejrzany przed utworzeniem linii bazowej, kliknij Poproś o przegląd obok typu dokumentu. Recenzenci projektu znajdą go w sekcji Dokumenty do przeglądu na stronie Moja praca i zatwierdzą go lub odrzucą tam albo na pasku pod tytułem.

Po późniejszych edycjach sprawdź, co się zmieniło:

  1. Kliknij Wersja ▾ → Porównaj wersje….
  2. Wybierz linię bazową w polu Od i Bieżąca wersja w polu Do.

    Raport wymienia każde dodanie, usunięcie i edycję. Kliknij Zmiany (Excel), aby go pobrać, lub Zmiany śledzone (Word), aby otrzymać plik Word ze zmianami śledzonymi.

Przykład: demo CubeSat EO-1

Utwórz demo przez Zarządzaj projektami → Pliki projektów ▾ → Nowy projekt demonstracyjny. Następnie otwórz Potrzeby i wymagania → Dokumenty → EO-1 System Requirements Specification (numer SRS-001).

Przeczytaj strukturę. Wymagania zawiera sześć sekcji:

  • 1 Mission Imaging
  • 2 Attitude Determination and Control
  • 3 Electrical Power
  • 4 Command and Data Handling
  • 5 Communications
  • 6 Ground Segment and Operations

Wymaganie 1.6 Revisit Time ma dwa elementy podrzędne: 1.6.1 Ground Track Repeat i 1.6.2 Off-Nadir Imaging. Kolumna Quality Score pokazuje paski. 2.5 Safe Mode Recovery i 6.4 Operator Interface mają niskie wyniki.

Popraw słabe sformułowania:

  1. Naciśnij ⌘F / Ctrl+F i wpisz should.

    Licznik pokazuje wyniki.

  2. Naciskaj Enter, aż zostanie oznaczone 2.5.

    Jego tekst to “The spacecraft should recover from safe mode quickly and resume imaging as appropriate”.

  3. Przepisz go, np. “The spacecraft shall resume imaging within 24 hours of a safe mode entry.”

    Kolumna wyniku pokazuje znacznik Nieaktualne, dopóki ponownie nie uruchomisz kontroli.

Podziel wymaganie złożone:

  1. Zaznacz 6.4 Operator Interface (“…shall be user friendly and/or easy to use.”).
  2. Kliknij je prawym przyciskiem myszy i wybierz Podziel na kilka elementów….
  3. Kliknij ✦ Zaproponuj podział.

    Otrzymujesz jedno mierzalne wymaganie na wiersz.

  4. Odznacz niechciane wiersze lub kliknij Połącz, aby scalić wiersz z następnym, a następnie kliknij Zastosuj.

Szybko dodaj wymaganie:

  1. W Szybkie dodawanie wybierz Pod 3 Electrical Power.
  2. Wpisz “The EPS shall provide a 5 V regulated bus within 3%.” i naciśnij Enter.

    Zostaje dodane jako 3.7 o nazwie “Provide A 5 V Regulated”.

Zobacz, co się zmieniło od SRR:

  1. Kliknij Wersja ▾ w tabliczce tytułowej i wybierz SRR Baseline.

    Baner brzmi “Linia bazowa “SRR Baseline”, tylko do odczytu, zapisana {date}”. Zatwierdzający to J. Rivera, Systems Lead; R. Okafor, Mission Principal Investigator; i L. Brandt, Program Manager.

  2. Kliknij Porównaj z bieżącym.

Raport wymienia:

  • 3.1 Orbit Average Power: opis zmieniony z 28 W na 30 W oraz nowe uzasadnienie.
  • 2.4 Target Slew: Status Draft → In Review.
  • Dodane 4.4 Downlink Encryption z dwoma nowymi powiązaniami satisfies.
  • Twoje własne edycje z tej sesji.

Opublikuj:

  1. Kliknij Wróć do bieżącego.
  2. Kliknij Dostarcz ▾ → Specyfikacja (Word).

    Plik Word zaczyna się od tytułu i “Requirements Document · No. SRS-001”. Następują wiersz Revision History dla SRR Baseline (“Initial baseline”) i trzy zatwierdzenia, a potem numerowane wymagania.

Wskazówki i dobre praktyki

  • Pisz jedno wymaganie na wiersz, z jednym “shall”. Podziel na kilka elementów… i kontrola jakości pomagają utrzymać wymagania pojedyncze.
  • Sekcje utrzymuj jako Statement, a wymagania jako Requirement. Kontrola jakości ocenia tylko Requirement. Raporty dotyczące tylko wymagań (RVTM, VCRM, RTM) pomijają Statement.
  • Twórz linię bazową przed każdym przeglądem i przed dużymi zmianami tekstu. Zależą od niej przywracanie i raporty zmian.
  • Kliknięcie wiersza go zaznacza. Aby edytować, kliknij samo pole albo naciśnij Enter lub F2 na zaznaczonym wierszu.
  • Użyj Widok ▾ → Papier, aby czytać dokument jak stronę, bez kolumn atrybutów. Wyłącz to, aby edytować atrybuty w kolumnach.
  • Obserwuj kropki statusu śledzenia: wymaganie jest gotowe do przeglądu, gdy jego kropka jest zielona.

Typowe błędy

  • Dodawanie jest wyszarzone. Aktywny jest filtr lub sortowanie (Widok filtrowany: edycja jest wyłączona. Wyczyść filtr na pasku narzędzi) albo wyświetlasz linię bazową. Kliknij ostrzeżenie lub kliknij Wróć do bieżącego.
  • Numery przeskoczyły po przeniesieniu. Automatyczna zmiana numeracji przepisuje numery grupy elementów równorzędnych. Aby zachować numery ustawione ręcznie, wyczyść Numeruj ponownie automatycznie po dodaniu lub przeniesieniu elementów w Pisz ▾ → Numeruj ponownie… lub zablokuj elementy, których numery nie mogą się zmieniać.
  • Usunięty element nadal jest w Bazie danych. Usuń tylko wyjmuje go z dokumentu. Aby go skasować, wybierz Usuń element… w następującym komunikacie, kliknij Usuń z ⇧ / Shift lub naciśnij ⇧Delete / Shift+Delete.
  • Numeracja literowa lub rzymska stała się dziesiętna. Automatyczna zmiana numeracji i Numeruj ponownie… tworzą numery dziesiętne (1, 1.1, 1.1.1). Aby zachować załączniki oznaczone literami, wyłącz automatyczną zmianę numeracji i numeruj je ręcznie.

Powiązania z innymi funkcjami

  • Źródła danych:
    • Import tworzy dokumenty z plików Word, Excel, CSV, ReqIF, XMI i tekstowych.
    • Szablony tworzą szkielet.
    • Generatory AI dodają wymagania.
  • Przekazuje dane do:
  • Wszędzie indziej: każdy element jest encją. Pojawia się w Bazie danych, Widoku elementu i na diagramach, takich jak Spider i drzewa.

Lista dokumentów

Lista dokumentów pokazuje każdy dokument w projekcie jako kartę, w tej samej galerii co strona Diagramy. Otwórz ją przez Potrzeby i wymagania → Dokumenty.

Każda karta pokazuje:

  • Miniaturę konspektu dokumentu.
  • Nazwę, typ i czas ostatniej edycji (najnowszej zmiany dokumentu lub dowolnego elementu).
  • “N elementów · N wymagań”.
  • Średnia jakość N%, gdy wymagania mają wyniki.
  • N TBD/TBR: otwarte kwestie.
Element sterującyCo robi
Szukaj dokumentów…Pokazuje karty, których nazwa, numer lub opis zawiera tekst.
SortowanieOstatnio edytowane (domyślnie), Numer (kolejność konspektu), Nazwa, Klasa.
Pigułki typówWszystkie i po jednej pigułce na typ dokumentu z liczbą.
Pokaż więcej (N)Pokazuje więcej kart.
Importuj (nagłówek strony)Otwiera stronę Import (Import i eksport).
+ Nowy dokument (nagłówek strony)Otwiera Nowy dokument.
⋯ na karcieOtwórz, Otwórz w ▸ Widok elementu, Duplikuj… i Usuń….

Usuń… otwiera Usuń dokument: “Usuwa “…”. Jego N sekcji pozostaje w projekcie jako elementy.” Gdy niektóre sekcje nie należą do żadnego innego dokumentu, Usuń także N sekcji, których nie używa żaden inny dokument usuwa również je. Cofnij przywraca wszystko.

Kliknij kartę, aby otworzyć dokument.

Adres documents/<id> otwiera dokument bezpośrednio. Dodaj ?baseline=<id> lub ?baseline=latest, aby otworzyć linię bazową, ?find=<text>, aby rozpocząć wyszukiwanie, lub ?comments=1, aby pokazać komentarze dokumentu w inspektorze.

Strona dokumentu

Strona dokumentu pokazuje jeden dokument jako konspekt i tabelę, z zaznaczonym elementem w inspektorze.

  • + Nowy {Class} dodaje element bieżącej klasy na końcu dokumentu. Jego ▾ otwiera menu klas:
    • Dodaj istniejący element….
    • Wstaw dokument… i Wstaw sekcję generowaną… (tylko kompilacje).
    • Pod nagłówkiem Dodaj na końcu: każda klasa Statement i Nagłówek (bieżąca ma ✔) oraz Inna klasa….
  • ✦ AI ▾ (na górnym pasku) zawiera narzędzia AI dokumentu (zobacz Narzędzia AI).

Pasek narzędzi

Element sterującyCo robi
+ PoDodaje element po zaznaczonym, na tym samym poziomie (⌘↵ / Ctrl↵). Jego ▾ dodaje Dodaj istniejący element…, Dodaj element podrzędny (⌥⌘ / Ctrl+Alt↵) i listę klas w sekcji Dodaj po wybranym elemencie.
+ PodrzędnyDodaje element podrzędny zaznaczonego elementu (⌥⌘↵ / Ctrl+Alt↵). Jego ▾ oferuje Dodaj istniejący element… i listę klas w sekcji Dodaj element podrzędny.
⇤ / ⇥Zmniejszenie wcięcia (⌥⇧← / Alt+Shift+←) / wcięcie (⌥⇧→ / Alt+Shift+→) zaznaczonego elementu.
↑ / ↓Przesunięcie zaznaczonego elementu w górę lub w dół między elementami równorzędnymi (⌥ / Alt+↑ / ⌥ / Alt+↓).
UsuńOd razu wyjmuje z dokumentu zaznaczone elementy wraz z ich poddrzewami (Delete działa tak samo). Usunięto z dokumentu. oferuje Cofnij i Usuń element…. Kliknięcie z ⇧ / Shift lub ⇧Delete / Shift+Delete usuwa elementy i ich elementy podrzędne po potwierdzeniu, które podaje, co zostanie usunięte. Esc lub × inspektora czyści zaznaczenie.
Pisz ▾Dodawanie, wstawianie, generowanie i edycja treści (zobacz Menu Pisz).
Sprawdź ▾Jakość, kontrole modelu, status śledzenia, powiązania do przeglądu, TBD/TBR i komentarze dla tego dokumentu, z liczbami (zobacz Menu Sprawdź).
Dostarcz ▾Ustawienia produktu dostarczanego i strony, szablon Word, wersje oraz eksporty pogrupowane według wyniku (zobacz Menu Dostarcz).
Widok ▾Bezpośrednie przełączniki dla tego dokumentu: Papier, Panel konspektu, Status śledzenia i Kolumny (zobacz Menu Widok).
Widok filtrowany: edycja jest wyłączona. Wyczyść filtrPojawia się, gdy włączony jest filtr klas lub etykiet albo sortowanie kolumny. Kliknij, aby je wyczyścić.
ZnajdźOtwiera pole wyszukiwania (⌘F / Ctrl+F).

Przyciski struktury są wyłączone, gdy:

  • Nic nie jest zaznaczone.
  • Zaznaczony element jest zablokowany.
  • Aktywny jest filtr lub sortowanie.
  • Wyświetlasz linię bazową.

Panel konspektu

Panel konspektu po lewej pokazuje hierarchię dokumentu z filtrem u góry. Nie ma kart: linie bazowe są w Wersja ▾ tabliczki tytułowej, a komentarze otwierają się w inspektorze.

  • ‹ ukrywa panel, a › przy lewej krawędzi ponownie go pokazuje (także Widok ▾ → Panel konspektu).
  • Przeciągnij jego prawą krawędź, aby zmienić jego szerokość (od 180 do 500 px).
  • Zaznaczenie elementu otwiera inspektor obok panelu; panel pozostaje otwarty.
  • Gdy panel i dokument mają łącznie mniej niż 900 px (licząc inspektor jako otwarty, aby zaznaczenie elementu tego nie zmieniało), panel się chowa. Otwiera się wtedy jako nakładka z ›. Kliknij poza nim, aby go zamknąć.

Filtruj u góry panelu:

  • Filtruj konspekt zawęża konspekt do elementów, których numer lub nazwa zawiera tekst, także zwiniętych. Ich elementy nadrzędne pozostają w konspekcie, przyciemnione, jako kontekst. Nie filtruje dokumentu.
  • Żetony klas, po jednym na klasę w dokumencie, z liczbą (pokazywane, gdy dokument ma więcej niż jedną klasę). Kliknij żeton, aby pokazać w dokumencie tylko tę klasę i jej podklasy; kliknij ponownie, aby pokazać wszystkie klasy. Kliknij żeton prawym przyciskiem myszy, aby wybrać {Class} i podklasy, Tylko {Class} lub Wyczyść filtr klas.
  • Żetony etykiet, po jednym na etykietę używaną w dokumencie, z liczbami. Klikaj żetony, aby pokazać tylko elementy z każdą wybraną etykietą. Dla elementów z dowolną z kilku etykiet użyj zapytania w Bazie danych.
  • Gdy żetonów jest więcej niż sześć, chowają się za Filtruj według klasy lub etykiety (n); po zwinięciu widoczne pozostają tylko aktywne żetony. Mniej filtrów ponownie je zwija. Ta przeglądarka zapamiętuje wybór.
  • Wyczyść filtr pojawia się, gdy włączony jest filtr lub sortowanie. Przefiltrowane wiersze zachowują wcięcia. Gdy włączony jest filtr lub sortowanie, edycja jest wyłączona.

Konspekt:

  • Każdy element ma próbkę koloru, numer i nazwę, 🔒, gdy jest zablokowany, oraz przełączniki ▾/▸.
  • Kliknij wpis, aby zaznaczyć element i przewinąć do niego.
  • Przeciągaj, aby zmienić kolejność (zobacz Przeciąganie i upuszczanie). Nieprawidłowe cele upuszczenia są oznaczane i odrzucane: element nie może trafić pod własny element podrzędny, pod zablokowany element ani pod klasę, która nie może być przez niego decomposed by.
  • Wiersze części dokumentu widocznej na ekranie są wyróżnione, a konspekt przewija się razem z dokumentem. Pozostaje w miejscu, gdy go wskazujesz, pracujesz w nim lub przewinięto go w ciągu ostatnich dwóch sekund.
  • Głębokie poziomy, które się nie mieszczą, pokazują znacznik poziomu L{n} zamiast kolejnego wcięcia.

Treść dokumentu

Treść zaczyna się od tabliczki tytułowej: typu i etykiet dokumentu, liczby elementów, “numerowane w dokumencie”, gdy włączone są numery dokumentu, 💬 n otwartych komentarzy (gdy są; zobacz Komentarze) i Wersja ▾ (zobacz Linie bazowe). Wersja ▾ pokazuje Bieżąca wersja, Bieżący · ostatnia linia bazowa {name} lub Linia bazowa: {name}. Pod nimi:

  • Nr i tytuł: kliknij, aby edytować numer i nazwę dokumentu, albo przejdź do nich klawiszem Tab i naciśnij Enter lub F2.
  • Opis dokumentu: kliknij, aby edytować go w edytorze tekstu sformatowanego, albo przejdź do niego klawiszem Tab i naciśnij Enter lub F2.
  • Tabela. Kolumna Encja zawiera każdy element: przełącznik, numer, nazwę, plakietki i opis. Pozostałe kolumny to kolumny atrybutów wybrane w Widok ▾ → Kolumny ▸: Status, Verification Method i Quality Score, dopóki ich nie zmienisz. Widok Papier nie ma żadnych.

Każdy wiersz pokazuje:

  • ▾/▸ do zwijania lub rozwijania elementów podrzędnych.
  • Numer i nazwę. Kliknij, aby edytować, lub przejdź do jednego z nich klawiszem Tab i naciśnij Enter lub F2. Enter zapisuje, a Esc anuluje; fokus pozostaje na polu. Wklejone podziały wierszy stają się spacjami.
  • Plakietki:
    • 🔒: element jest zablokowany.
    • ⚡: element zawiera wskazówki. Wskaż go, aby je przeczytać.
    • 💬 n: nierozwiązane komentarze. Kliknij, aby otworzyć je w inspektorze.
    • ⚠ Przegląd: zmieniło się wymaganie nadrzędne w łańcuchu.
    • Plakietka klasy.
    • Kropka statusu śledzenia (tylko wymagania; zobacz Status śledzenia).
  • Opis, edytowany w edytorze tekstu sformatowanego.
  • Kolorowy pasek przy lewej krawędzi: niebieski, gdy element nie zmienił się od najnowszej linii bazowej, bursztynowy, gdy jest nowy lub zmieniony.
  • Komórki atrybutów:
    • Etykiety pokazują żetony z × do usuwania i + do dodawania. Menu wymienia etykiety dozwolone dla klasy albo “Brak kolejnych etykiet”.
    • Atrybuty tekstowe edytuje się w miejscu. Pozostałe atrybuty używają edytora swojego typu.
    • Quality Score pokazuje kolorowy pasek: zielony od 67%, bursztynowy od 34% do 66%, czerwony poniżej. Pokazuje znacznik Nieaktualne z ikoną zegara, gdy tekst zmienił się po ostatniej kontroli; wskaż go, aby zobaczyć powód.
    • “—” oznacza, że klasa nie ma takiego atrybutu.

Sortowanie i szerokości kolumn:

  • Kliknij nagłówek kolumny, aby sortować rosnąco, ponownie, aby sortować malejąco, i po raz trzeci, aby wyłączyć sortowanie.
  • Sortowanie wymienia elementy płasko, bez hierarchii, i wstrzymuje tworzenie treści.
  • Przeciągnij prawą krawędź nagłówka, aby zmienić szerokość kolumny. Kolumna Encja ma co najmniej 300 px szerokości, pozostałe co najmniej 80 px. Szerokości są zapamiętywane dla każdego dokumentu w tej przeglądarce.
  • Pusty wiersz odstępu oddziela sekcje najwyższego poziomu.

Zaznaczanie wierszy:

  • Kliknij wiersz, aby go zaznaczyć. Kliknięcie tylko zaznacza; aby edytować, kliknij pole albo naciśnij Enter lub F2 na wierszu.
  • Aby usunąć zaznaczenie, kliknij puste miejsce pod tabelą, naciśnij Esc lub kliknij ✕.
  • ↑ i ↓ przenoszą zaznaczenie między wierszami.
  • Kliknięcie z ⌘ / Ctrl (Ctrl+kliknięcie w systemach Windows i Linux) dodaje element do zaznaczenia lub go z niego usuwa.
  • Kliknięcie z ⇧ / Shift zaznacza zakres od ostatnio klikniętego elementu do bieżącego, w pokazanej kolejności (z uwzględnieniem sortowania lub filtru). Kliknięcie z ⌘ / Ctrl+⇧ / Shift dodaje ten zakres do zaznaczenia.
  • ⌘A / Ctrl+A na elemencie z fokusem (nie podczas edycji) zaznacza każdy pokazany element. ⇧ / Shift+↑ i ⇧ / Shift+↓ rozszerzają zaznaczenie od elementu z fokusem.
  • Te same gesty działają w panelu Konspekt. Pasek narzędzi pokazuje liczbę (“Zaznaczono: 21”). Zwykłe kliknięcie lub Esc przywraca zaznaczenie jednego elementu.
  • Kliknięcia w edytowanym polu zachowują zwykłe działanie tekstu: kliknięcie z ⇧ / Shift rozszerza tam zaznaczenie tekstu.

Menu kontekstowe

Kliknij prawym przyciskiem myszy element w dokumencie (jego numer, nazwę, plakietki lub miejsce wokół nich) albo wpis w panelu Konspekt, aby otworzyć jego menu przy wskaźniku. Z klawiatury ustaw fokus na wierszu lub wpisie konspektu i naciśnij Shift+F10 lub klawisz menu; menu otwiera się przy elemencie, a Esc przywraca tam fokus. Na ekranie dotykowym dotknij elementu i przytrzymaj. Element staje się zaznaczeniem.

Menu zaczyna się od maksymalnie trzech sugerowanych działań wybranych na podstawie stanu elementu, każde z uzasadnieniem po prawej stronie: np. ✦ Dodaj mierzalne kryteria… (niespełnione: Unambiguous), ✦ Generuj przypadek testowy… (niezweryfikowane), Przejrzyj powiązanie… (zmiana wyżej w łańcuchu) lub Rozstrzygnij TBD… (otwarte TBD). Gdy nie ma nic do poprawienia, sugeruje ✦ Sprawdź z AI… i ✦ Zapytaj AI o ten element…. ✦ Więcej AI ▸ wymienia każde działanie AI dla elementu. Reguły i pełna lista są w Model i baza danych. Każde działanie AI pokazuje wynik do przejrzenia, zanim cokolwiek się zmieni. Gdy AI jest wyłączone, część AI to jeden wygaszony wiersz z podanym powodem.

Polecenia za separatorem. Klawisz pokazany po prawej stronie polecenia robi to samo z klawiatury (zobacz Skróty klawiaturowe):

PolecenieCo robi
Przejdź doTylko konspekt. Przewija dokument do elementu i przenosi na niego fokus (Enter na wpisie konspektu).
OtwarcieOtwiera Widok elementu.
Zmień nazwę…Zmienia nazwę. F2 na elemencie z fokusem w dokumencie edytuje nazwę w miejscu.
Dodaj {class} poDodaje element bieżącej klasy po tym elemencie, tak jak + Po (⌘↵ / Ctrl↵).
Dodaj podrzędny {class}Dodaje element bieżącej klasy pod tym elementem, tak jak + Podrzędny (⌥⌘↵ / Ctrl+Alt↵).
Zwiększ wcięcie, Zmniejsz wcięcieJak ⇥ i ⇤ na pasku narzędzi (⌥⇧→ / Alt+Shift+→ i ⌥⇧← / Alt+Shift+←).
Przenieś w górę, Przenieś w dółJak ↑ i ↓ na pasku narzędzi (⌥ / Alt+↑ i ⌥ / Alt+↓).
Status ▸, Priorytet ▸Ustawia atrybut; bieżąca wartość jest zaznaczona.
Powiąż z ▸Wymienia najpierw relacje najczęściej używane dla klasy, a potem Wszystkie relacje ▸ z każdą relacją dozwoloną dla klasy. Wybranie relacji otwiera wybór encji docelowych.
Pokaż na diagramie ▸Wymienia typy diagramów, które mogą pokazać element; wybranie typu go otwiera.
Kopiuj łączeKopiuje łącze do Widoku elementu.
Kopiuj numerKopiuje numer elementu.
Otwórz w ▸Widok elementu, Historia…, diagramy, które mogą pokazać element (hierarchii, drzewa, Spider, Action, Asset, Risk, osi czasu), Macierz identyfikowalności, Jakość wymagań i Analiza funkcjonalna.
Przenieś pod ▸Lista z filtrowaniem przez wpisywanie, zawierająca elementy, które mogą zawierać ten element, z wcięciami w kolejności dokumentu, oraz Najwyższy poziom dokumentu, gdy element ma element nadrzędny. Elementy podrzędne przenoszą się razem z nim.
Podziel na kilka elementów…Zobacz Podział na kilka elementów.
Zmień klasę…Otwiera Zmień klasę (to samo okno co w Bazie danych; zobacz Model i baza danych).
Numeruj ponownie od tego miejsca…Otwiera Zmianę numeracji dla tego elementu, jego późniejszych elementów równorzędnych i ich elementów podrzędnych.
Ustaw atrybut w tej gałęzi…Zobacz Ustawianie atrybutu w tej gałęzi.
Zablokuj / OdblokujBlokuje element przed edycją lub go odblokowuje.
Usuń z tego dokumentuWyjmuje element i jego elementy podrzędne z dokumentu (Delete). Encje pozostają w projekcie; komunikat oferuje Cofnij i Usuń element….
Usuń element…Usuwa element i jego elementy podrzędne po potwierdzeniu (⇧Delete / Shift+Delete).

Każde polecenie można cofnąć jednym poleceniem Cofnij. Polecenia, których nie można zastosować, są wygaszone, a ich podpowiedź podaje powód:

  • W linii bazowej lub przy dostępie tylko do odczytu działają tylko Przejdź do, Otwórz, Pokaż na diagramie ▸, Kopiuj łącze i Kopiuj numer. W linii bazowej sugestie i działania ✦ AI też są wygaszone.
  • Na zablokowanym elemencie Zmień nazwę…, Status ▸, Priorytet ▸, Powiąż z ▸, przenoszenie i Usuń element… są wygaszone.
  • Gdy aktywny jest filtr lub sortowanie, dodawanie i przenoszenie są wygaszone (“Najpierw wyczyść filtr lub sortowanie”).
  • Polecenia, które przeniosłyby element przed początek lub za koniec jego poziomu, są wygaszone (np. Przenieś w górę na pierwszym elemencie).

Zaznaczonych kilka elementów. Kliknięcie prawym przyciskiem myszy elementu z zaznaczenia działa na wszystkich zaznaczonych elementach. Menu pokazuje Zaznaczono: N i oferuje działania zbiorcze ✦ (✦ Sprawdź z AI (wymagania: n)…, ✦ Przeredaguj (n) ▸, ✦ Generuj przypadki testowe (n)…, ✦ Zapytaj AI o te elementy (n)…, ✦ Zaproponuj ślady (n)…; zobacz AI dla kilku zaznaczonych elementów), Ustaw status ▸, Ustaw priorytet ▸, Dodaj do dokumentu ▸, Usuń z tego dokumentu (n) i Usuń elementy (n)… (po potwierdzeniu; elementy podrzędne zaznaczonych elementów są usuwane razem z nimi). Polecenia dla jednego elementu (Przejdź do, Otwórz, Zmień nazwę…, dodawanie, wcinanie i przenoszenie) pozostają na liście, ale są wygaszone z powodem “Działa na jednej encji”. Każde polecenie to jeden krok cofania. Kliknięcie prawym przyciskiem myszy elementu spoza zaznaczenia czyni go jedynym zaznaczonym elementem.

Opis i każde edytowane pole zachowują własne menu przeglądarki, więc można tam kopiować, wklejać i sprawdzać pisownię. Kliknięcie prawym przyciskiem myszy z ⌥ / Alt pokazuje menu przeglądarki w dowolnym miejscu.

Szybkie dodawanie

Szybkie dodawanie pozwala wpisywać wymagania jedno po drugim bez użycia paska narzędzi. Pasek pod dokumentem zawiera Szybkie dodawanie, listę sekcji, pole tekstowe i Dodaj. Lista sekcji oferuje Koniec dokumentu oraz Pod {number name} dla każdej sekcji najwyższego poziomu.

Wpisz wymaganie i naciśnij Enter lub kliknij Dodaj. Nowy element otrzymuje:

  • Bieżącą klasę.
  • Tekst jako opis.
  • Nazwę utworzoną z pierwszych słów po “shall”, “must”, “will” lub “should”: do pięciu słów, wielkimi literami na początku wyrazów.

Pole przyjmuje do 2000 znaków. Gdy włączony jest filtr lub sortowanie, pole pokazuje “Wyczyść filtr lub sortowanie, aby dodawać encje”.

Inspektor

Zaznaczony element otwiera się w inspektorze po prawej stronie z pełnym panelem encji (zobacz Model i baza danych).

  • W dokumencie relacje decomposed by i decomposes są tam tylko do odczytu, ponieważ steruje nimi konspekt.
  • × w nagłówku (Esc) czyści zaznaczenie. Widok ▾ → Zwiń elementy podrzędne zwija sekcje pod zaznaczonym elementem.
  • Zablokowane elementy otwierają się tylko do odczytu.

Dodawanie elementów

Nowe elementy

  • + Nowy {Class} dodaje na końcu.
  • + Po dodaje po zaznaczonym elemencie.
  • + Podrzędny dodaje ostatni element podrzędny zaznaczonego elementu, a element nadrzędny się rozwija.
  • Bez zaznaczenia + Po i + Podrzędny dodają na końcu.

Nowy element ma nazwę “New {Class}”. Jest zaznaczony, a jego nazwa otwiera się do edycji.

Inne klasy

Inna klasa… otwiera Dodaj element do dokumentu z polami Klasa (dowolna klasa) i Nazwa. Używaj jej dla elementów innych niż Statement, np. opisu Asset lub Test Case w planie testów.

Dokumenty strukturalne z nagłówkami

Heading to sekcja dokumentu (podejście artefaktów strukturalnych z LML 2.0). Używaj Heading, gdy sekcja łączy klasy, np. wymagania, akcje i ryzyka, albo gdy to samo wymaganie pojawia się w kilku dokumentach.

  1. Wybierz Nagłówek w menu klas (+ Nowy ▾, + Po ▾ lub + Podrzędny ▾). Dla Heading na najwyższym poziomie dokument jest jego source of; pod innym Heading jest numerowaną podsekcją.
  2. Zaznacz Heading i użyj + Podrzędny ▾, aby dodać jego treść: nowy element dowolnej klasy lub Dodaj istniejący element…. Heading contains ten element.
  3. Treść zachowuje własny numer: dodawanie, przenoszenie i Numeruj ponownie… numerują Heading i pozostawiają numery treści bez zmian, więc wymaganie takie jak RQ.CLN.1 brzmi tak samo w każdym dokumencie. Treść sekcji jest wymieniana przed podsekcjami.

Przeniesienie treści do innego Heading (przeciągnięcie, Przenieś pod ▸) przenosi jej powiązanie contains. Kontrole modelu liczą wymaganie zawarte w Heading jako umieszczone w dokumencie.

Aby zapisać, skąd pochodzi wymaganie, powiąż je ze źródłowym Artifact relacją originated by (inspektor → Relacje; Artifact wymienia je w originates). Projekt utworzony przed wprowadzeniem Heading zachowuje swój schemat; Schemat → Dodaj nowe wbudowane… dodaje Heading, contains i originates.

Przykład w demo CubeSat EO-1: sekcja 7 Applicable Documents dokumentu EO-1 System Requirements Specification jest Heading. Jej treścią są dwie normy projektu, które zachowują numery STD-1 i STD-2. STD-1 originates wymaganie 3.4 Bus Regulation, a STD-2 originates 5.2 UHF Command Uplink.

Istniejące encje

Dodaj istniejący element… otwiera wybór encji. Wybór pomija dokument i jego bieżące elementy. Encja jest dodawana z całą dekompozycją. Gdy wnosi elementy podrzędne, komunikat brzmi “Dodano {entity} z N encjami podrzędnymi”.

Zmiana struktury

Wcięcie, zmniejszenie wcięcia i przenoszenie

  • Zwiększ wcięcie czyni element ostatnim elementem podrzędnym elementu równorzędnego powyżej. Pierwszego elementu grupy nie można wciąć.
  • Zmniejsz wcięcie czyni element następnym elementem równorzędnym jego elementu nadrzędnego.
  • Przenieś w górę/w dół zamienia element miejscami z sąsiadem. Zablokowane elementy i zablokowani sąsiedzi się nie przesuwają.
  • Gdy przeniesienie nie jest możliwe, komunikat brzmi “Zaznaczonej encji nie można przesunąć dalej w tym kierunku.”

Przeciąganie i upuszczanie

Przeciągaj w panelu Konspekt. Lista przewija się, gdy przeciągasz blisko jej górnej lub dolnej krawędzi. Wynik zależy od miejsca upuszczenia:

  • Górne 28% wiersza: element trafia przed niego.
  • Dolne 28% wiersza: element trafia za niego.
  • Środek wiersza: element staje się jego elementem podrzędnym.
  • Nazwa dokumentu u góry: element staje się elementem najwyższego poziomu na końcu.

Przenoszenie pod element

Kliknij element prawym przyciskiem myszy i wybierz Przenieś pod ▸. Lista zawiera elementy, które mogą przyjąć go jako element podrzędny, z wcięciami w kolejności dokumentu, oraz Najwyższy poziom dokumentu, gdy element ma element nadrzędny. Wpisz tekst, aby przefiltrować listę, a następnie wybierz nowy element nadrzędny. Elementy podrzędne przenoszą się razem z nim; komunikat brzmi “Przeniesiono {item}”.

Lista pomija własne poddrzewo elementu, jego bieżący element nadrzędny, zablokowane elementy i elementy nadrzędne niedozwolone przez schemat. Gdy przeniesienie się nie uda, komunikat brzmi “Nie można przenieść elementu w to miejsce: nowy element nadrzędny jest w nim lub element jest zablokowany. Wybierz inny element nadrzędny lub odblokuj element.”

Numeracja

Automatyczna zmiana numeracji

Numeruj ponownie automatycznie po dodaniu lub przeniesieniu elementów jest domyślnie włączone; zmień to w Pisz ▾ → Numeruj ponownie…. Gdy jest włączone, te działania zmieniają numerację grupy elementów równorzędnych, której dotyczą, i wszystkich potomków: dodawanie, przenoszenie, wcinanie, zmniejszanie wcięcia, usuwanie i dzielenie.

  • Elementy najwyższego poziomu otrzymują wzorzec numeru dokumentu z kolejnym numerem. Zaczyna się on od pierwszego numeru dokumentu: 1, chyba że zmieniono go w Numeruj ponownie….
  • Elementy podrzędne otrzymują numer elementu nadrzędnego, kropkę i kolejny numer (3, 3.1, 3.1.1).
  • Zablokowane elementy i wpisy słowniczka (elementy z etykietą Acronym, których numerem jest termin) zachowują numery, ale nadal zajmują pozycję.

Gdy jest wyłączone:

  • Nowy element otrzymuje kolejny numer po elemencie poprzedzającym. Pierwszy element podrzędny otrzymuje numer elementu nadrzędnego z .1.
  • Istniejące numery się nie zmieniają.
  • Przeniesienie elementu zmienia numerację tylko przeniesionego poddrzewa.
  • Przenieś w górę/w dół zamienia oba numery.

Reguły następnego numeru

Aby kontynuować sekwencję, Holarch zwiększa ostatnią część poprzedniego numeru. Zachowuje separatory i końcową kropkę, dwukropek lub nawias.

  • Cyfry: 1.9 → 1.10, 2. → 3.
  • Litery: a → b, z → aa, Z → AA, Appendix A → Appendix B
  • Liczby rzymskie z co najmniej dwóch liter: IV → V, IX → X. Pojedyncza litera jest traktowana jak litera (I → J).
  • Do wszystkiego innego dopisywane jest .1.

Zmiana numeracji

Pisz ▾ → Numeruj ponownie… zmienia numerację całego dokumentu w jednym kroku. Numeruj ponownie od tego miejsca… w menu kontekstowym elementu zmienia numerację tego elementu, jego późniejszych elementów równorzędnych i wszystkich ich elementów podrzędnych.

Okno zawiera:

  • Wzorzec: {n} to pozycja, a {n:3} dopełnia ją do trzech cyfr. SYS-{n:3} daje SYS-001, SYS-002; ich elementy podrzędne są numerowane pod nimi: SYS-001.1, SYS-001.2. Wzorzec bez {n} otrzymuje numer na końcu. Przy otwarciu z elementu wzorzec i pierwszy numer są wstępnie wypełniane na podstawie jego numeru.
  • Pierwszy numer (tylko cyfry). Inne dane pokazują “Wpisz pierwszy numer cyframi, np. 1.”
  • Tabela podglądu z kolumnami Element, Bieżący i Nowy (zmienione numery są wyróżnione; do 400 wierszy) oraz licznik, np. “Zmieni się 12 z 40 numerów.”
  • Numeruj ponownie automatycznie po dodaniu lub przeniesieniu elementów (tylko cały dokument).
  • Uwaga “Zablokowane elementy zachowują swoje numery. Jedno Cofnij cofa całe ponowne numerowanie.” Wpisy słowniczka też zachowują swoje.
  • Zmień numerację. Komunikat brzmi “Zaktualizowano numery dokumentu”.

Uruchomienie dla całego dokumentu zapisuje wzorzec i pierwszy numer z dokumentem. Późniejsza automatyczna zmiana numeracji ich używa.

Numeracja dokumentu (numery meta)

Numeracja dokumentu przechowuje osobne numery dla każdego dokumentu. Używaj jej, gdy to samo wymaganie pojawia się w dwóch dokumentach pod różnymi numerami.

Włącz ją przez Dostarcz ▾ → Ustawienia produktu dostarczanego… → Numeracja → Numery dokumentu (przechowywane tylko w tym dokumencie). Numery modelu (własne numery elementów) ją wyłącza.

  • Po jej włączeniu bieżący numer każdego elementu jest kopiowany do dokumentu.
  • Od tej pory edycje numerów zmieniają tylko ten dokument.
  • Gdy jest włączona, tabliczka tytułowa pokazuje “· numerowane w dokumencie”.
  • Eksporty i raporty używają numerów dokumentu.

Szablony

Szablony pochodzą z czterech miejsc. Nowy dokument i Użyj szablonu wymieniają je w tej kolejności, najpierw szablony danego typu dokumentu:

GrupaGdzie jest przechowywanyKto może go dodać lub zmienić
Szablony organizacji: {name}Na serwerach Holarch (hostowanych lub samodzielnie utrzymywanych), dla organizacjiAdministratorzy organizacji
Szablony projektuW pliku projektu; widzi je każdy członek projektuWłaściciele projektu (w aplikacji komputerowej: każdy, kto otworzy projekt)
Szablony wbudowaneW HolarchNikt
Zapisane w tej przeglądarceTylko w tej przeglądarce (szablony zapisane przed wersją 1.8.0)Zaimportuj je do projektu

Szablony wbudowane

Każdy szablon wbudowany ma numerowane sekcje z tabelami startowymi (np. tabelami Revision History i Approvals). Z opcją Uwzględnij wskazówki redakcyjne każda sekcja zaczyna się też od krótkiego przewodnika pisania.

Nowy dokument pokazuje liczbę sekcji każdego szablonu, np. “39 sekcji” dla Requirements Specification.

Szablony odpowiadają powszechnej praktyce inżynierii systemów dla każdego rodzaju dokumentu: specyfikacje wymagań interesariuszy, systemowych, oprogramowania i interfejsów, dokument kontroli interfejsów, opis architektury, weryfikacja i walidacja, plany testów i ryzyka, procedury i raporty z testów, analizy kompromisów oraz zarządzanie konfiguracją.

Wiele sekcji zawiera bloki dynamiczne, które aktualizują się na podstawie modelu przy każdym wyświetleniu lub eksporcie dokumentu:

BlokW
VCRM, VCRM według poziomów, RVTM i RTM własnych wymagań dokumentuSpecyfikacje wymagań (sekcje Verification i Traceability)
VCRM i RVTM całego projektuTest Plan, Verification and Validation Plan, Test Procedure, Test Report
Macierz interfejsów i lista kanałówInterface Control Document, Architecture Description
Macierz alokacji (funkcje do komponentów)Concept Definition, Architecture Description
Obiekty Statement z etykietą AcronymKażda sekcja Acronyms
Artefakty z etykietą ReferenceKażda sekcja References
Ryzyka; artefakty Trade StudyRisk Management Plan; Trade Study Report

Macierz obejmująca “ten dokument” wskazuje nowy dokument. Dla Test Report dodaj wyniki cyklu testów przez Wstaw ▸ Macierz… ▸ Test Report i wybierz zestaw i cykl testów.

Zapisywanie dokumentu jako szablonu

Zapisz strukturę dokumentu jako szablon, aby rozpoczynać od niego nowe dokumenty.

  1. Wybierz Pisz ▾ → Szablony ▸ Zapisz jako szablon….

    Otwiera się Zapisz {Type} jako szablon.

  2. Wpisz Nazwa szablonu.
  3. W polu Zapisz w wybierz:
    • Ten projekt: może go używać każdy członek projektu. Tę opcję widzą tylko właściciele projektu.
    • Organizacja: {name} (serwery Holarch, administratorzy organizacji): może go używać każdy członek organizacji. Zaznacz Ustaw jako domyślny szablon organizacji dla {Type}, aby był wstępnie wybierany w oknie Nowy dokument.
  4. Zaznacz Dołącz pliki i obrazy, jeśli szablon ma je zachować.
  5. Kliknij Zapisz.

Szablon zapisuje klasę, nazwę, numer, opis, poziom, etykiety i zwykłe wartości atrybutów każdego elementu. Wyniki jakości są pomijane. Macierz obejmująca zapisany dokument obejmuje nowy dokument po zastosowaniu szablonu.

Jeśli nie możesz zapisać żadnego rodzaju szablonu, okno o tym informuje: poproś właściciela projektu lub administratora organizacji.

Zarządzanie szablonami

Pisz ▾ → Szablony ▸ Zarządzaj szablonami… wymienia szablony projektu. Właściciele mogą je Zmień nazwę i Usuń; Cofnij przywraca usunięty szablon. Dokumenty utworzone z szablonu się nie zmieniają.

Administratorzy organizacji zarządzają szablonami organizacji w Ustawienia organizacji → Szablony dokumentów: otwórz organizację i użyj Szablony dokumentów, aby zmienić nazwę szablonu, włączyć lub wyłączyć Domyślny (jeden domyślny na typ dokumentu) lub go usunąć.

Szablony zapisane w tej przeglądarce

Przed wersją 1.8.0 szablony własne były zapisywane w przeglądarce. Gdy właściciel projektu po raz pierwszy otworzy listę szablonów, Holarch proponuje skopiowanie ich do projektu: Importuj do projektu lub Nie teraz. Do tego czasu pozostają wymienione w sekcji Zapisane w tej przeglądarce. Zarządzaj szablonami… ma dla nich Importuj do projektu i Usuń z przeglądarki.

Stosowanie szablonu do istniejącego dokumentu

Pisz ▾ → Szablony ▸ Zastosuj szablon… otwiera Użyj szablonu z polami Typ dokumentu, Szablon, Zapisz ten dokument jako szablon… i Zarządzaj szablonami….

Zastosuj dodaje sekcje szablonu, z numerami i zagnieżdżeniem, na końcu dokumentu. Komunikat brzmi “Dodano N sekcji.” Cofnij je usuwa.

Edytor tekstu sformatowanego

Edytor tekstu sformatowanego edytuje opisy z formatowaniem, tabelami, obrazami i treścią dynamiczną. Kliknij opis (lub opis dokumentu), aby go edytować. Z klawiatury przejdź do opisu klawiszem Tab i naciśnij Enter lub F2; czytniki ekranu ogłaszają go jako pole tekstowe nazwane według elementu (“Opis 1.2 Power Budget”).

Edytor otwiera się w miejscu z paskiem narzędzi, licznikiem słów i znaków (“słowa: N · znaki: N”) i wskazówką “⌘↩ / Ctrl+Enter zapisz · Esc anuluj · Tab opuść”.

  • Aby zapisać, naciśnij ⌘↵ / Ctrl↵, kliknij ✓, kliknij poza edytorem lub naciśnij Tab, aby go opuścić.
  • Aby anulować, naciśnij Esc. Fokus wraca do opisu.
  • Każdy zapis można cofnąć jednym poleceniem Cofnij.
  • Tab nigdy nie wcina, więc nie zatrzymuje w edytorze. Wcinaj listy za pomocą ⌘ / Ctrl+] / ⌘ / Ctrl+[ lub ⇤ / ⇥.

Pasek narzędzi

PrzyciskCo robi
+Menu Wstaw: ✦ Napisz z AI…, Obraz…, Tekst alternatywny… (gdy tekst zawiera obrazy), Tabela…, Blok kodu, Linia, Łącze…, Łącze do dokumentu…, Plik…, Diagram…, Wartość dynamiczna…, Liczba lub suma…, Tabela dynamiczna…, Macierz…, Odsyłacz…, Symbol… oraz Aktualizuj rysunki diagramów, gdy tekst zawiera obrazy diagramów
✦Narzędzia tekstowe AI (zobacz poniżej)
¶ ▾Styl akapitu: Tekst, od Nagłówek 1 do Nagłówek 4, Cytat, Blok kodu
B / I / UPogrubienie (⌘B / Ctrl+B), kursywa (⌘I / Ctrl+I), podkreślenie (⌘U / Ctrl+U)
⋯Podkreślenie (⌘U / Ctrl+U), Przekreślenie, Indeks górny, Indeks dolny, Kod w tekście, Wyróżnienie, Wyczyść formatowanie (⌘⇧M / Ctrl+Shift+M)
• / 1.Lista punktowana (⌘⇧8 / Ctrl+Shift+8) / lista numerowana (⌘⇧7 / Ctrl+Shift+7)
⇤ / ⇥Zmniejszenie wcięcia (⌘[) / wcięcie (⌘])
≡ ▾Wyrównanie: Do lewej, Do środka, Do prawej, Wyjustuj
▦Wstaw tabelę… oraz, wewnątrz tabeli, operacje na tabeli
🔗Łącze (⌘K / Ctrl+K)
APróbki Kolor tekstu i Tło (po dziesięć kolorów) oraz Usuń kolor
AaCzcionka (Arial, Brush Script MT, Comic Sans MS, Garamond, Georgia, Helvetica, Impact, monospace, Times New Roman) i Rozmiar (od 10 do 60 px) dla zaznaczenia
↶ / ↷Cofnij (⌘Z / Ctrl+Z) / ponów (⇧⌘Z / Ctrl+Shift+Z) w edytorze
</>Źródło HTML (⌘/ / Ctrl+/); po powrocie źródło jest oczyszczane
⤢Pełny ekran; Esc najpierw opuszcza pełny ekran
✓Zapisz (⌘↵ / Ctrl↵)

Czcionka, rozmiar i style obejmujące zaznaczenie wymagają zaznaczenia. Bez niego komunikat brzmi “Najpierw zaznacz tekst.”

Tabele

Wstaw tabelę pyta o Wiersze (domyślnie 2), Kolumny (domyślnie 3) i Wiersz nagłówka (włączony). Tab i Shift+Tab przechodzą między komórkami. Tab w ostatniej komórce (lub Shift+Tab w pierwszej) opuszcza edytor.

Wewnątrz tabeli kliknij ▦ lub kliknij komórkę prawym przyciskiem myszy, aby wybrać operacje na tabeli:

  • Dodaj wiersz powyżej, Dodaj wiersz poniżej, Dodaj kolumnę po lewej, Dodaj kolumnę po prawej.
  • Dodaj wiersz nagłówka, Dodaj podpis, Scal z komórką po prawej.
  • Usuń wiersz, Usuń kolumnę, Usuń wiersz nagłówka, Usuń podpis, Usuń tabelę.

Obrazy i pliki

  • Obraz… wstawia plik obrazu jako rysunek. Okno Wstaw obraz pyta o Tekst alternatywny (co przedstawia obraz) lub Dekoracyjny (tekst alternatywny niepotrzebny) dla obrazu, który nie wnosi informacji.
  • Obraz można też wkleić lub upuścić plik obrazu w edytorze. Takie obrazy nie mają początkowo tekstu alternatywnego; komunikat brzmi “Dodano obraz bez tekstu alternatywnego. Dodaj go w menu + (Tekst alternatywny…).”
  • Wklejenie adresu obrazu (kończącego się na .png, .jpg, .jpeg, .gif lub .webp) wstawia obraz.
  • Obrazy większe niż 4000 px na dłuższym boku są zmniejszane. Powiadomienie brzmi “Zmniejszono obraz do W × H px (limit to 4000 px na dłuższym boku).”
  • Plik obrazu powyżej limitu na plik jest przerysowywany do szerokości 1600 px jako JPEG. Jeśli nadal jest za duży, komunikat brzmi “Obraz przekracza limit N MB.”
  • Plik… dołącza dowolny plik jako łącze do pobrania, z ikoną jego typu. Pliki powyżej limitu pokazują “Plik przekracza limit N MB.”

Tekst alternatywny

Tekst alternatywny opisuje obraz dla czytników ekranu i w sprawdzaniu ułatwień dostępu programu Word.

  • + → Tekst alternatywny… wymienia każdy obraz w tekście z jego tekstem alternatywnym i polem Dekoracyjny. Ostrzega, gdy obraz nie ma tekstu alternatywnego lub gdy tekstem alternatywnym jest nazwa pliku.
  • Kliknij obraz dwukrotnie lub kliknij go prawym przyciskiem myszy i wybierz Edytuj tekst alternatywny…, aby edytować tylko ten jeden.
  • Obrazy diagramów (Diagram…) biorą tekst alternatywny z podpisu: typu diagramu i nazwy encji.
  • Wynik Word zapisuje tekst alternatywny w opisie każdego obrazu. Obraz dekoracyjny jest oznaczony jako dekoracyjny.
  • Łącze… (Wstaw łącze) przyjmuje URL i Tekst. Adresy bez http:, https:, mailto: lub # otrzymują https://. Łącza otwierają się w nowej karcie.
  • Łącze do dokumentu… (Wstaw łącze do dokumentu) łączy z innym dokumentem. Przyjmuje Dokument, Wersja (Bieżąca lub Linia bazowa: {name}) i Tekst.
    • W wyniku Word dokumenty połączone w ten sposób można dołączyć jako załączniki.
    • Bez innych dokumentów komunikat brzmi “Ten projekt nie ma innych dokumentów. Najpierw utwórz dokument.”

Treść dynamiczna

Treść dynamiczna jest aktualna względem modelu wszędzie, gdzie pokazywany jest tekst: w dokumencie, w inspektorze, w eksportach i w wyszukiwaniu.

  • Diagram… (Wstaw diagram): wybierz Typ diagramu i encję (lub tablicę albo ramkę). Wstawia obraz diagramu z podpisem, połączony z diagramem.
    • Obraz jest dynamiczny. Gdy model się zmienia, dokument po chwili pokazuje nowy obraz, a Word i inne eksporty rysują go od nowa.
    • Aby zachować bieżący obraz, kliknij dwukrotnie rysunek w edytorze (Rysunek diagramu) i wyłącz Aktualizuj obraz przy zmianie modelu. Rysunek staje się wtedy migawką.
    • Aktualizuj rysunki diagramów (w +) od razu przerysowuje każdy dynamiczny rysunek w tekście.
    • Gdy encja diagramu zostanie usunięta, rysunek zachowuje ostatni obraz.
  • Wartość dynamiczna…: wybierz encję i Atrybut. Edytor pokazuje jego “Wartość dynamiczna”. Aby zmienić atrybut, kliknij dwukrotnie wartość dynamiczną (Edytuj wartość dynamiczną).
  • Liczba lub suma… wstawia liczbę obliczaną ponownie na podstawie modelu, do streszczenia lub wiersza statusu, np. “12 z 40 wymagań jest zweryfikowanych” (dwie liczby). Jej pola:
    • Zapytanie: które encje liczyć, np. class:Requirement AND Requirement:"Status=Approved". Zobacz składnia wyszukiwania.
    • Zakres: Cały projekt, ten dokument lub inny dokument. Kompilacja jako zakres obejmuje wszystkie jej części.
    • Funkcja: Liczba, Suma, Średnia, Minimum lub Maksimum. Wszystkie oprócz Liczba pytają o Atrybut liczbowy, np. Amount obiektu Cost. Gdy nie ma liczb do zsumowania, wartość to N/A.
    • Bieżąca wartość. Aby później zmienić liczbę, kliknij ją dwukrotnie.
  • Macierz… wstawia dynamiczną macierz RTM, RVTM, VCRM, alokacji lub inną. Zobacz Generowanie dokumentów.
  • Tabela dynamiczna… wstawia tabelę encji z zapytania. Wiersze są obliczane ponownie przy każdym wyświetleniu lub eksporcie tekstu. Jej pola:
    • Zapytanie, np. class:Requirement AND label:"Functional Requirement". Domyślnie order:modified-. Zobacz składnia wyszukiwania.
    • Zakres: Cały projekt, ten dokument lub inny dokument albo kompilacja.
    • Kolumny (w kolejności): domyślnie Number, Name. + Dodaj atrybut… dodaje kolumnę atrybutu. + Dodaj kolumnę relacji… dodaje kolumnę wymieniającą powiązane encje, np. Verified by.
    • Limit: domyślnie 10. Wszystkie wiersze wymienia każde dopasowanie.
    • Podgląd do 50 wierszy.
    • Aby później zmienić tabelę dynamiczną, kliknij ją dwukrotnie.
  • Zakres arkusza kalkulacyjnego… wstawia komórki arkusza kalkulacyjnego jako tabelę lub jako wykres wybranego typu (albo jeden z wykresów samego arkusza), z podpisem. Wybierz arkusz kalkulacyjny, arkusz i zakres oraz opcjonalnie udostępniony widok do śledzenia. Tabela i wykres pokazują bieżące wartości i aktualizują się przy zmianie komórek; Word i inne eksporty używają wartości z chwili eksportu. Gdy zakres zostanie usunięty, tabela zachowuje ostatnie wiersze i jest oznaczana jako brakująca.
  • Odsyłacz… (Wstaw odsyłacz) odwołuje się do części otwartego dokumentu przez jej bieżący numer:
    • Sekcja lub element pokazuje numer i nazwę elementu, np. “3.2 Frost Warning”. Inna encja… wybiera encję spoza dokumentu.
    • Rysunek i Tabela wymieniają rysunki i tabele dokumentu, które mają podpis, jako “Rysunek 2” lub “Tabela 1”. Wybranie takiego, który nie ma jeszcze klucza odwołania, dodaje mu klucz.
    • Tekst nadąża za zmianą numeracji. W wyniku Word odsyłacze stają się polami, które Word aktualizuje numerami podpisów. Odsyłacz, którego cel usunięto, zachowuje tekst i jest oznaczany.
  • Symbol… wstawia jeden z symboli: ± ° µ Ω ≈ ≠ ≤ ≥ × ÷ √ ∞ ∑ π Δ, strzałki, • … — –, © ® ™ § ¶, € £ ¥ ¢, ½ ¼ ¾ ² ³, ✓ ✗.

Narzędzia tekstowe AI

✦ przeredagowuje zaznaczenie albo bieżący akapit, gdy nic nie jest zaznaczone. Gdy nie ma na czym pracować, komunikat brzmi “Brak tekstu do przeredagowania.”

Narzędzia:

  • Popraw sformułowania, Uprość, Popraw pisownię i gramatykę, Skróć, Dodaj szczegóły, Dokończ zdanie.
  • Przeredaguj w innym tonie…: akademickim, stanowczym, swobodnym, pewnym siebie, konstruktywnym, empatycznym, ekscytującym, płynnym, formalnym, przyjaznym, inspirującym, profesjonalnym.
  • Przetłumacz… i Przetłumacz cały tekst…: arabski, chiński, angielski, francuski, niemiecki, grecki, włoski, japoński, koreański, portugalski, rosyjski, hiszpański, szwedzki, ukraiński.
  • Napisz z AI….

Podgląd pokazuje Bieżący, Sugerowany i Zmiany. Wybierz Zastąp, Ponów próbę lub Odrzuć.

Wklejanie

Wklejony tekst sformatowany zachowuje strukturę: nagłówki, listy, tabele i łącza. Traci klasy, style w tekście (poza komórkami tabel) i znaczniki Office. Skrypty, ramki i niebezpieczne łącza są usuwane z każdego tekstu sformatowanego.

Skróty edytora tekstu sformatowanego

KlawiszeCzynność
⌘↵ / Ctrl↵Zapisz i zamknij
EscAnuluj (lub opuść pełny ekran)
⌘B / Ctrl+B / ⌘I / Ctrl+I / ⌘U / Ctrl+UPogrubienie / kursywa / podkreślenie
⌘K / Ctrl+KŁącze
⌘⇧7 / Ctrl+Shift+7 / ⌘⇧8 / Ctrl+Shift+8Lista numerowana / punktowana
⌘] / ⌘[Zwiększ / zmniejsz wcięcie
Tab / Shift+TabNastępna / poprzednia komórka tabeli; poza tabelą opuszcza edytor (zapisuje)
⌘⇧M / Ctrl+Shift+MUsuń formatowanie
⌥⌘0 / Ctrl+Alt+0Akapit tekstu
Od ⌥⌘1 / Ctrl+Alt+1 do ⌥⌘4 / Ctrl+Alt+4Od Nagłówek 1 do Nagłówek 4
⌘/ / Ctrl+/Źródło HTML
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZCofnij / ponów w edytorze

Wyszukiwanie w dokumencie

Kliknij Znajdź lub naciśnij ⌘F / Ctrl+F, aby przeszukać dokument. Pole wyszukiwania pokazuje “n z m”.

Wyszukiwanie obejmuje numer, nazwę i opis każdego elementu, wartości w wyświetlanych kolumnach oraz komunikaty kontroli jakości. Pomija elementy ukryte przez filtr.

  • Enter lub ▼ przechodzi do następnego dopasowania.
  • Shift+Enter lub ▲ przechodzi do poprzedniego dopasowania.
  • Esc czyści tekst, a × zamyka pole.

Zwinięte sekcje otwierają się, aby pokazać dopasowanie. Pasujące wiersze są wyróżnione, a bieżący jest oznaczony.

Znajdowanie i zastępowanie

Pisz ▾ → Znajdź i zamień… otwiera Znajdź i zamień. Zawiera:

  • Znajdź i Zamień.
  • Pola do przeszukania: Nazwa, Numer i Opis. Numer jest domyślnie wyłączony.
  • Uwzględniaj wielkość liter i Tylko całe wyrazy.

Wiersz pod polami brzmi “Pasujące encje: N (zablokowane encje są pomijane).” Zamień wszystko zmienia każde dopasowanie w elementach dokumentu, a jedno polecenie Cofnij wycofuje całość. Komunikat brzmi “Zaktualizowano encje: N” lub “Brak dopasowań”. W tekście sformatowanym zmienia się tylko tekst: formatowanie, łącza i notacje pozostają nienaruszone.

Menu Pisz

Pisz ▾ zawiera polecenia dodające i zmieniające treść. Polecenia dodające elementy są wygaszone w linii bazowej, przy dostępie tylko do odczytu oraz gdy włączony jest filtr lub sortowanie; podpowiedź podaje powód.

ElementCo robi
Dodaj element ▸Klasy Statement i Inna klasa…. Dodaje element po zaznaczonym albo na końcu, gdy nic nie jest zaznaczone. Wybrana klasa staje się bieżącą klasą.
Dodaj istniejący element…Zobacz Istniejące encje.
Wstaw ▸Treść dynamiczna do opisu zaznaczonego elementu: Wartość dynamiczna…, Liczba lub suma…, Tabela dynamiczna…, Macierz…, Obraz diagramu…, Zakres arkusza kalkulacyjnego… i Odsyłacz…. Edytor opisu otwiera się na końcu tekstu z wybranym oknem (zobacz Treść dynamiczna). Wygaszone, dopóki nie zostanie zaznaczony niezablokowany element (“Najpierw zaznacz niezablokowany element”). W kompilacji oferuje też Dokument… i Sekcja generowana… (zobacz Kompilacje).
✦ Generuj wymagania…Generator AI, pod zaznaczonym elementem lub dla całego dokumentu. Każdy wynik jest pokazywany w podglądzie przed dodaniem.
✦ Generuj wymagania podrzędne…Z zaznaczonym obiektem Statement lub wymaganiem: jego nowe elementy podrzędne.
✦ Generuj ryzyka…Z zaznaczonym elementem: ryzyka dla niego.
✦ Generuj przypadek testowy…Z zaznaczonym wymaganiem: przypadek testowy, który je weryfikuje.
✦ Streść…Tworzy element streszczenia, utrzymywany na początku dokumentu, bez numeru.
✦ Przetłumacz…Tłumaczy tekst dokumentu, z podglądem.
Znajdź i zamień…Zobacz Znajdowanie i zamiana.
Numeruj ponownie…Zobacz Zmiana numeracji.
Szablony ▸Zastosuj szablon… (Stosowanie szablonu), Zapisz jako szablon… (Zapisywanie dokumentu jako szablonu) i Zarządzaj szablonami… (Zarządzanie szablonami).

Ustawianie atrybutu w tej gałęzi

Kliknij element prawym przyciskiem myszy i wybierz Ustaw atrybut w tej gałęzi…, aby ustawić jedną wartość w elemencie i wszystkich jego potomkach. Wybierz Dodaj etykietę, Usuń etykietę lub atrybut, a następnie wartość. Okno informuje: “Dotyczy {item} i jego potomków (N). Zablokowane encje są pomijane.” Komunikat brzmi “Zaktualizowano encje: N (pominięto zablokowane: k)”.

Podział na kilka elementów

Kliknij element prawym przyciskiem myszy i wybierz Podziel na kilka elementów…, aby rozbić wymaganie złożone na pojedyncze. Okno ma tytuł Podziel na kilka elementów: {item}.

  1. Wybierz Dziel na zdania lub Dziel na akapity oraz Nowe elementy jako jego elementy podrzędne lub Nowe elementy po nim.

    Tabela pokazuje jeden proponowany element na część, z numerem, edytowalnymi polami Nazwa i Tekst.

  2. Możesz też kliknąć ✦ Zaproponuj podział, aby AI zaproponowało pojedyncze wymagania (do 20).
    • Wiersze, których tekst zawiera adres internetowy, są początkowo odznaczone.
    • Gdy oryginał jest zatwierdzony, objęty linią bazową lub zablokowany, zastąpienie jego tekstu jest odznaczoną opcją do włączenia.
    • Porównanie pokazuje wiersz 1 względem oryginału.
  3. Edytuj nazwy i tekst. Połącz scala część z następną.
  4. Odznacz niechciane części i kliknij Zastosuj.

Część 1 (“pozostaje”) zostaje w oryginalnym elemencie. Każda zaznaczona część staje się nowym elementem tej samej klasy z tymi samymi etykietami. Numery są proponowane automatycznie; przy włączonej automatycznej zmianie numeracji są nadawane ponownie po podziale. Jedno polecenie Cofnij wycofuje cały podział; komunikat brzmi “Podzielono na elementy: N”.

Menu Sprawdź

Sprawdź ▾ wymienia, co wymaga uwagi w tym dokumencie, z liczbami po prawej stronie:

ElementCo robi
Sprawdź jakośćSprawdza każde wymaganie w dokumencie, które przechodzi bieżący filtr, i otwiera wyniki. Gdy zaznaczone jest wymaganie, pozycja to Sprawdź jakość tego wymagania. Bez wymagań: “Ten dokument nie ma wymagań do sprawdzenia. Obiekty Statement nie są oceniane.”
Kontrole modelu dla tego dokumentu…Otwiera Kontrole modelu dla tego dokumentu: wyniki kontroli modelu dla dokumentu i jego elementów (reguła, element, wynik) oraz treść dynamiczną wskazującą coś, czego brakuje. Kliknij element, aby go zaznaczyć. Gdy nie ma żadnych: “Brak wyników dla tego dokumentu.” Otwórz kontrole modelu otwiera stronę dla całego projektu.
Status śledzenia…Pokazuje “Kompletne: N z M” i otwiera Status śledzenia: wymagania, które nie są jeszcze alokowane ani zweryfikowane, każde z kropką i informacją, czego brakuje (satisfied by, verified by). Kliknij jedno, aby je zaznaczyć. Otwórz RVTM otwiera stronę RVTM. Pokazywane, gdy dokument ma wymagania.
Powiązania do przegląduOtwiera Powiązania do przeglądu dla tego dokumentu.
Rejestr TBD/TBROtwiera rejestr TBD/TBR dla tego dokumentu.
Znajdź akronimy…Zobacz Znajdowanie akronimów.
KomentarzePokazuje liczbę otwartych komentarzy i otwiera je w inspektorze (zobacz Komentarze).

Status śledzenia

Kropka po plakietkach każdego wymagania pokazuje jego status śledzenia:

  • Zielona: wymaganie jest satisfied by czymś (alokowane) i verified by czymś.
  • Bursztynowa: brakuje jednego z tych dwóch.
  • Czerwona: nie istnieje żadne z tych powiązań.

Wskaż kropkę, aby zobaczyć status i to, czego brakuje, np. “Status śledzenia: Częściowo śledzone. Brakuje: brak powiązania verified by (niezweryfikowane).” Kliknij ją, aby otworzyć menu z elementami w sekcjach Satisfied by (alokacja) i Verified by (kliknij jeden, aby go otworzyć), Otwórz w RVTM i Powiąż z ▸. Obiekty Statement i inne klasy nie mają kropki. W linii bazowej kropki pokazują powiązania z linii bazowej. Wyłącz kropki przez Widok ▾ → Status śledzenia.

Znajdowanie akronimów

Sprawdź ▾ → Znajdź akronimy… znajduje akronimy w numerach, nazwach i opisach dokumentu i dodaje je do jego sekcji Glossary, na jednej liście do przeglądu.

  • Akronim to co najmniej dwie wielkie litery, do ośmiu znaków, nie same cyfry.
  • Rozwinięcie pochodzi z istniejącego wpisu projektu albo ze słów obok terminu, których inicjały go tworzą (“Concept of Operations” → CONOPS).
  • Każdy wiersz ma Zachowaj, Termin, Rozwinięcie i Użycia (kliknij “N użyć”, aby zobaczyć każde miejsce wystąpienia). Uwaga oznacza terminy już “w słowniczku”, z “wpis istnieje w projekcie” lub z “nie znaleziono rozwinięcia”.
  • Terminy z rozwinięciem, których nie ma jeszcze w słowniczku, są początkowo zaznaczone. Pole w nagłówku zaznacza lub odznacza wszystkie.
  • Powiąż każde użycie w tekście z jego wpisem w słowniczku (wartość dynamiczna) (włączone) zamienia każde użycie w opisach na wartość dynamiczną numeru wpisu, połączoną z wpisem.

Kliknij Dodaj do słowniczka. Każdy zaznaczony termin staje się obiektem Statement z etykietą Acronym, z Number = termin i Name = rozwinięcie, w sekcji najwyższego poziomu Glossary dokumentu (używana jest istniejąca sekcja o nazwie Glossary lub Acronyms; w przeciwnym razie na końcu dodawana jest nowa). Wpis, który już istnieje w projekcie, jest używany ponownie zamiast tworzenia drugiego. Jedno polecenie Cofnij wycofuje całość. Gdy nic nie zostanie znalezione, widzisz “Brak akronimów w tym dokumencie. Akronimy to wyrazy z co najmniej dwiema wielkimi literami, np. CONOPS.”; gdy nic nie jest zaznaczone, “Zaznacz co najmniej jeden termin.” Zmiana numeracji pomija wpisy słowniczka.

Menu Dostarcz

Dostarcz ▾ konfiguruje produkt dostarczany i eksportuje go, z podziałem według wyniku:

ElementCo robi
Ustawienia produktu dostarczanego…Numeracja, strona tytułowa, nagłówek bieżący i blok podpisów (zobacz Ustawienia produktu dostarczanego).
Ustawienia strony…Oznaczenie, strona okładki i numery stron (zobacz Format strony).
Szablon Word ▸Szablony Word, z ✔ przy szablonie używanym przez ten dokument, oraz Edytuj szablony Word…. Wybranie szablonu czyni go szablonem tego dokumentu.
Wersja ▸Zapisz linię bazową… i Porównaj wersje… (zobacz Linie bazowe).
Word: po jednej pozycji {template} (Word) na szablon WordOd razu pobiera dokument w formacie Word z opcjami danego szablonu; własny szablon dokumentu pokazuje “ten dokument”. Z linii bazowej wynikiem jest linia bazowa.
Konspekt (Word)…Konspekt jako nagłówki, opcjonalnie ze spisem treści.
Zmiany śledzone (Word)…Zobacz Zmiany śledzone. Wymaga linii bazowej.
Excel: Macierz identyfikowalności…Standardowa macierz jako Excel, Word, CSV lub strona internetowa (zobacz Generowanie dokumentów).
Zmiany (Excel)…Zmiany od linii bazowej do późniejszej lub do bieżącej wersji. Wymaga linii bazowej.
Wymiana: Wymagania (ReqIF)…, Dane dokumentu (JSON)…Formaty wymiany (zobacz Raporty).
Drukuj lub PDF…Zobacz Druk / PDF.
Wszystkie eksporty…Każdy eksport z opcjami (zobacz Raporty).

Szablony Word

Szablon Word to nazwany zestaw opcji eksportu Word i strony. Kształtuje plik Word, a nie treść (treść wypełniają szablony dokumentów; zobacz Szablony). Każdy dokument używa jednego; domyślny to Specyfikacja. Wybierz go w Dostarcz ▾ → Szablon Word ▸.

Szablony wbudowane:

SzablonOpcje
SpecyfikacjaSpis treści do poziomu 3, numerowane podpisy, spisy rysunków i tabel, historia zmian i zatwierdzenia z linii bazowych, połączone dokumenty jako załączniki. Kolumny atrybutów, gdy dokument jakieś pokazuje.
Produkt dostarczany według rozdziałówJak Specyfikacja, z podpisami numerowanymi według rozdziałów (Rysunek 3-1) i nagłówkami z opisów w spisie treści.
Kopia do przegląduStrony poziome z kolumnami atrybutów dokumentu pod każdym elementem; spis treści do poziomu 2, bez tabel części wstępnej.
ProstyTytuł, nagłówki i tekst: bez spisu treści, numerów podpisów i tabel części wstępnej.

Wszystkie szablony wbudowane używają stron Letter.

Edytuj szablony Word… otwiera Szablony Word. Szablony wbudowane mają Kopiuj; kopia staje się szablonem projektu, przechowywanym w projekcie dla każdego członka. Zaznacz szablon projektu, aby zmienić:

  • Nazwa, Rozmiar strony (Letter (8,5 × 11 in) lub A4 (210 × 297 mm)) i Orientacja (Pionowa lub Pozioma).
  • Spis treści (Brak, Poziom 1, Poziomy 1–2, Poziomy 1–3, Poziomy 1–4, Każdy poziom) i Numery podpisów (Rysunek 1, Tabela 1, Według rozdziałów: Rysunek 3-1 lub Wyłączone).
  • Spis rysunków i spis tabel (gdy są podpisy), Nagłówki wewnątrz opisów pojawiają się w spisie treści, Kolumny atrybutów pokazane w dokumencie, pod każdym elementem, Powiązane dokumenty jako załączniki i Historia zmian i zatwierdzenia z linii bazowych.
  • Usuń szablon.

Kliknij Zapisz (jedno polecenie Cofnij to wycofuje; komunikat brzmi “Zapisano szablony Word.”). Dokument, którego szablon usunięto, wraca do szablonu Specyfikacja.

Firmowe pliki Word

Szablon projektu może zawierać własny plik Word organizacji (.docx lub .dotx, do 5 MB). Eksport używa wtedy następujących elementów pliku:

  • Style: czcionki, kolory, style nagłówków i tekstu podstawowego. Style, których brakuje w pliku (podpisy, pozycje spisu treści), są dodawane; numeracja nagłówków z pliku jest pomijana, ponieważ nagłówki numeruje Holarch.
  • Strona: rozmiar, orientacja i marginesy. Wybranie pliku ustawia odpowiednio Rozmiar strony i Orientacja szablonu.
  • Nagłówki i stopki z logo i numerami stron. Do każdego dodawane jest oznaczenie projektu lub dokumentu.
  • Strona tytułowa: zawartość pliku przed pierwszym podziałem sekcji lub cały plik, gdy go nie ma. Zastępuje stronę tytułową Holarch.

Na stronie tytułowej oraz w nagłówkach i stopkach wypełniane są te symbole zastępcze: {{Title}}, {{Type}}, {{Number}}, {{Version}}, {{Date}}, {{Project}}, {{Organization}}, {{Contract}}, {{CDRL}}, {{Prepared For}}, {{Prepared By}} i {{Baseline}}. Wielkość liter i spacje nie mają znaczenia. Inny tekst w nawiasach klamrowych pozostaje bez zmian.

Aby go dodać:

  1. Wybierz Dostarcz ▾ → Szablon Word ▸ → Edytuj szablony Word….
  2. Kliknij Wybierz… w wierszu Firmowy plik Word lub zaznacz szablon projektu i kliknij Wybierz… pod Firmowy plik Word.
  3. Wybierz plik. Kliknij Zapisz.

Zastąp… wymienia plik, a Usuń przywraca style i stronę tytułową Holarch. Plik, który nie jest dokumentem Word, jest odrzucany z komunikatem “Plik nie jest dokumentem Word (.docx lub .dotx).” Treść sięgająca poza dokument jest pomijana: połączone obrazy, osadzone obiekty i formanty oraz pola INCLUDETEXT, INCLUDEPICTURE, DDE, LINK i IMPORT. Makra nigdy nie są odczytywane.

Strona szablonu ustala też szerokość widoku Papier: strony Letter mają 816 px szerokości, A4 794 px, w orientacji poziomej więcej. W Wszystkie eksporty… → Dokument (Word) opcje zaczynają się od szablonu dokumentu; Szablon Word wypełnia je tam z innego szablonu, a dla jednego eksportu można je zmienić.

Menu Widok

Widok ▾ zawiera bezpośrednie przełączniki dla tego dokumentu:

  • Papier (✔, gdy włączony): pokazuje dokument jako strony, tak szerokie jak strona szablonu Word, bez kolumn atrybutów. Requirements Document zaczynają z wyłączonym widokiem; pozostałe typy z włączonym.
  • Panel konspektu: pokazuje lub ukrywa panel konspektu.
  • Status śledzenia: pokazuje lub ukrywa kropki statusu śledzenia. Domyślnie włączone.
  • Kolumny ▸ (wygaszone w widoku Papier): każdy atrybut klas w dokumencie i pola elementu (Class, Number, Created On, Modified On, Labels), z ✔ przy pokazanych kolumnach. Wybierz jedną, aby ją pokazać lub ukryć; nowa kolumna trafia na koniec. Domyślne kolumny przywraca Status, Verification Method i Quality Score.
  • Zwiń wszystko oraz Rozwiń wszystko, gdy coś jest zwinięte.
  • Zwiń elementy podrzędne: zwija sekcje pod zaznaczonym elementem (wygaszone, dopóki nie zostanie zaznaczony element z podsekcjami).
  • Resetuj widok: czyści zwinięcia, filtry, sortowanie i wyszukiwanie. Pokazuje też panel konspektu w domyślnej szerokości, resetuje szerokości kolumn i przywraca domyślne kolumny.
  • Otwórz w ▸: otwiera zaznaczony element lub, gdy nic nie jest zaznaczone, dokument w innym widoku: Widok elementu, Historia… (każda zarejestrowana zmiana, z porównaniem słów dla każdego pola), diagramy, które mogą go pokazać, Macierz identyfikowalności (dokument jako oś wierszy), Jakość wymagań (w zakresie dokumentu) i Analiza funkcjonalna.
  • Pomoc.

Kliknij prawym przyciskiem nagłówek kolumny, aby użyć poleceń Przenieś w lewo, Przenieś w prawo i Ukryj kolumnę.

Kolumny są zapamiętywane dla każdego dokumentu w tej przeglądarce. Ostatni wybór jest punktem wyjścia dla dokumentów, których jeszcze nie skonfigurowano. Papier i Status śledzenia są zapisywane razem z dokumentem. Pozycja przewijania w poziomie nie zmienia się po zaznaczeniu wiersza.

Linie bazowe

Wersja ▾ w bloku tytułowym zawiera Bieżąca wersja, linie bazowe tego dokumentu oraz, w sekcji Linie bazowe projektu, linie bazowe projektu (każda z datą; ✔ oznacza tę, która jest wyświetlana). Na końcu są polecenia Zapisz linię bazową… i Porównaj wersje…. Dostarcz ▾ → Wersja ▸ zawiera te same dwa polecenia.

Tworzenie linii bazowej

  1. Kliknij Wersja ▾ → Zapisz linię bazową… (polecenie jest wygaszone, gdy wyświetlana jest linia bazowa: “Najpierw wróć do bieżącej wersji”).

    Okno Zapisz linię bazową otwiera się z uwagą “Linia bazowa zachowuje tę wersję dokumentu (jego elementy, ich atrybuty i relacje), aby można ją było później wyświetlić, porównać i przywrócić. Zapisy zatwierdzeń otrzymują bieżącą datę i nie można ich później edytować.”

  2. Wpisz Nazwa (wymagane). Domyślnie jest to “{document} – linia bazowa N”.
  3. W sekcji Zatwierdzenia wypełnij jeden wiersz na każdego zatwierdzającego: Nazwa, Rola i Treść. Pierwszy wiersz jest wstępnie wypełniony Twoim imieniem i nazwiskiem. Domyślna treść to “Zatwierdzono do wydania.”
  4. Kliknij + Dodaj zatwierdzającego, aby dodać kolejne wiersze, lub ×, aby usunąć wiersz. Wiersze bez nazwy są pomijane.
  5. Kliknij Utwórz.

    Komunikat brzmi “Zapisano linię bazową”.

Wyświetlanie linii bazowej

Wybierz linię bazową w menu Wersja ▾. Baner brzmi “Linia bazowa “{name}”, tylko do odczytu, zapisano {date}” (z dopiskiem “· linia bazowa projektu” dla linii bazowej projektu) i wymienia zatwierdzających. Zawiera polecenia:

  • Wróć do bieżącego: wraca do kopii roboczej.
  • Edytuj (linie bazowe dokumentu): otwiera okno Edytuj linię bazową. Można zmienić nazwę linii bazowej lub dodać zapisy zatwierdzeń w sekcji Dodaj zatwierdzenia. “Nowe zapisy otrzymują bieżącą datę i są dodawane do listy. Istniejących zapisów nie można zmienić.”
  • Porównaj z bieżącym (linie bazowe dokumentu): otwiera okno Porównaj wersje od tej linii bazowej.
  • Przywróć linię bazową: pyta “Zastąpić elementy, kolejność i strukturę tego dokumentu linią bazową “{name}”? Elementy dodane od tego czasu zostaną usunięte z dokumentu (nie skasowane). Można to cofnąć.”
    • Dla linii bazowej projektu otwiera okno Zastąp projekt linią bazową: “Zastąpić cały projekt linią bazową projektu “{name}”? Można to cofnąć.”
  • Usuń: pyta “Usunąć linię bazową “{name}”?”

W linii bazowej edycja, szybkie dodawanie i narzędzia struktury są wyłączone, a konspekt pokazuje 🔒. Dostarcz ▾ tworzy wyniki z linii bazowej (“Eksportuj (linia bazowa “{name}”)”).

Zawartość dynamiczna w linii bazowej pokazuje model linii bazowej, na ekranie i w wynikach: wartości dynamiczne, liczby i sumy, tabele dynamiczne, macierze i odsyłacze są rozwiązywane względem migawki, a rysunki diagramów zachowują obrazy zapisane z linią bazową. Linia bazowa dokumentu zawiera dokument, jego elementy oraz encje odległe o jedną relację, więc liczba lub tabela w niej obejmuje te encje; wartość dynamiczna encji spoza linii bazowej pokazuje jej bieżącą wartość.

Porównywanie wersji

Wersja ▾ → Porównaj wersje… otwiera okno Porównaj wersje. Porównuje Od (linię bazową) z Do: późniejszą linią bazową lub Bieżąca wersja. Bez linii bazowych pokazuje “Ten dokument nie ma linii bazowej. Najpierw ją zapisz.”

Wyświetla “N zmian” z kolumnami Numer, Nazwa, Zmień typ, Pole i Zmiana. Dla zmienionego tekstu kolumna Zmiana pokazuje różnice na poziomie słów.

Typy zmian:

  • Dodano i Usunięto.
  • Zmodyfikowano: polem jest Name, Number, Description, Class, Image lub dowolny atrybut.
  • Dodano etykietę i Usunięto etykietę.
  • Dodano relację, Usunięto relację i Atrybut relacji.

Zmiany (Excel) pobiera porównanie z kolumnami Number, Name, Class, Change Type, Field, Old Value i New Value. Zmiany śledzone (Word) pobiera to samo porównanie jako dokument Word ze zmianami śledzonymi (zobacz Zmiany śledzone).

Raporty

Dostarcz ▾ eksportuje dokument do formatu Word, PDF, arkuszy kalkulacyjnych i innych formatów. Pozycje {template} (Word) pobierają plik od razu (zobacz Szablony Word); każda pozycja Word ma pod nazwą jednowierszowy opis. Usuń dokument… na końcu menu usuwa dokument, opcjonalnie razem z sekcjami, których nie używa żaden inny dokument (zobacz Lista dokumentów), a następnie wraca do listy. Konspekt (Word)…, Zmiany śledzone (Word)…, Zmiany (Excel)…, Wymagania (ReqIF)…, Dane dokumentu (JSON)… i Drukuj lub PDF… otwierają okno Eksportuj z tym wyborem; Wszystkie eksporty… otwiera je z ostatnim wyborem.

  1. Kliknij Dostarcz ▾ → Wszystkie eksporty….

    Otwiera się okno Eksportuj.

  2. Wybierz, co eksportować, w polu Eksportuj jako. Opcje mają nazwy w postaci “<zawartość> (<format>)” i są pogrupowane według wyniku: Word, Excel, CSV, strona internetowa, tekst, wymiana i druk.
  3. Ustaw opcje.
  4. Edytuj Nazwa pliku (do 99 znaków).
  5. Kliknij Eksportuj.

Podgląd pokazuje pierwsze 60 wierszy raportów arkuszowych. Dla innych eksportów pokazuje “Podgląd pokazuje tylko eksporty arkuszy kalkulacyjnych. Wybierz eksport do Excela.” Raporty używają numerów dokumentu, a w linii bazowej – zawartości linii bazowej.

RaportWyjścieOpcje
Dokument (Word)Dokument w formacie Word (zobacz Wynik w formacie Word)Szablon Word (szablon dokumentu; wybranie innego wypełnia poniższe opcje na jego podstawie), Dodaj spis treści, Głębokość spisu treści od 1 do 6, Numery podpisów (Rysunek 1, Tabela 1, Według rozdziałów: Rysunek 3-1, Tabela 3-1 lub Wył.), Spis rysunków i spis tabel (gdy dokument ma podpisy), Nagłówki wewnątrz opisów pojawiają się w spisie treści, Uwzględnij kolumny atrybutów pokazane w dokumencie, Dodaj powiązane dokumenty jako załączniki, Wypełnij tabele historii zmian i zatwierdzeń na podstawie linii bazowych. Wartości domyślne pochodzą z szablonu; w szablonie Specification: spis treści do poziomu 3, proste numery podpisów, spisy, kolumny, gdy są pokazane, załączniki i tabele linii bazowych włączone, nagłówki wyłączone. Rozmiar i orientacja strony pochodzą z szablonu.
Zmiany (Excel)Każdy dodany, usunięty i zmieniony element, atrybut i relacja między dwiema wersjamiOd (linia bazowa, domyślnie najstarsza), Do (Bieżąca wersja lub linia bazowa); bez linii bazowej “Ten dokument nie ma linii bazowej. Najpierw ją zapisz.”
Tabela (CSV)Jeden wiersz na elementAtrybuty (w kolejności kolumn) (domyślnie Number, Name, Description i wyświetlane kolumny; także dowolna pozycja Relationship: {name}, wymieniająca powiązane elementy), Sortuj według Hierarchiczna, Numer lub Nazwa
Komentarze (Excel)Jeden wiersz na każdy komentarz do dokumentu i jego elementów, z autorem komentarzaUwzględnij klasę, nazwę, numer i opis, Data, Rozwiązane (wszystkie włączone)
Dane dokumentu (JSON)Dokument do ponownego importuBezpośrednio powiązane encje (wył.), Komentarze (wł.), Linie bazowe (wył.), Historia (wył.)
Konspekt (Word)Tylko nagłówki, numerowaneDodaj spis treści (wył.)
Dokument (Markdown)Dokument jako nagłówki i tekst Markdownbrak
Dokument (druk lub PDF)Okno drukowania przeglądarki; wybierz tam zapis jako PDFbrak
Zmiany śledzone (Word)Dokument ze zmianami śledzonymi programu Word (zobacz Zmiany śledzone)Z linii bazowej (najnowsza), Cel (późniejsza linia bazowa lub Bieżący)
Ustalenia jakości (Excel)Dziewięć wierszy na wymaganie (jeden na kryterium) z komunikatem i zielonym Tak lub czerwonym Nie oraz końcowa “Ocena w raporcie”Więcej atrybutów, Uwzględnij datę utworzenia, datę modyfikacji i Global ID
Wymagania (ReqIF)ReqIF XML z hierarchią i powiązaniami traced to, satisfied by, verified by, satisfies, verifies i traced from wewnątrz dokumentubrak
RSM (Excel)Requirement → elementy satisfied byAtrybuty wymagania (Number, Name), Atrybuty powiązanej encji (Class, Number, Name, Description)
RTM (Excel)Requirement → elementy traced tojak w RSM
RVM (Excel)Requirement → elementy verified byjak w RSM
RVTM (Excel)Requirement → weryfikujące elementy Test Case, z każdym wierszem dokumentuAtrybuty wymagania (Number, Name, Description, Verification Method(s)), Atrybuty Test Case (Number, Name, Description, Status)
TVM (Excel)Elementy Test Case w dokumencie → wymagania, które weryfikująAtrybuty Test Case (Number, Name, Status), Atrybuty wymagania (Number, Name, Description)
VCRM (Excel)Wymagania × metody weryfikacji ze znakiem XAtrybuty wymagania (Number, Name), Metody weryfikacji (wszystkie)
Macierz identyfikowalności (Excel), (Word), (CSV), (HTML)Standardowa macierz dokumentu lub całego projektu (zobacz Generowanie dokumentów)Macierz, Zakres (Ten dokument lub Cały projekt)

W raportach macierzowych:

  • Wymaganie bez powiązanego elementu jest zacieniowane na czerwono. W VCRM wymaganie bez metody jest zacieniowane na czerwono.
  • Komórki wymagania są scalane w obrębie jego powiązanych wierszy.
  • Dwa wiersze nagłówka są zablokowane.

Wynik Word

Dokument (Word) tworzy plik Word w tej kolejności:

  1. Strona tytułowa (gdy w Ustawieniach strony włączone jest Strona tytułowa albo w Ustawieniach produktu dostarczanego Strona tytułowa), a w przeciwnym razie tytuł i wiersz kursywą z typem i “Nr {number}”. Z linii bazowej wiersz zawiera dodatkowo “Linia bazowa: {name} ({date})”. Klauzula oznaczenia (Ustawienia strony) pojawia się w ramce pod tytułem.
  2. Historia zmian (Version, Date, Author, Changes): jeden wiersz na linię bazową dokumentu, od najstarszej, aż do eksportowanej linii bazowej.
    • Pierwszy wiersz brzmi “Początkowa linia bazowa”. Kolejne wiersze brzmią “dodane: N, usunięte: N, zmienione: N” lub “Brak zmian”.
    • Author to twórca linii bazowej lub jej zatwierdzający.
  3. Zatwierdzenia (Role, Name, Statement, Date) z najnowszej (lub eksportowanej) linii bazowej. Bez zapisów zatwierdzeń planowani zatwierdzający z Ustawień produktu dostarczanego otrzymują blok podpisów: Role, Name, Signature i Date z pustymi liniami do podpisu.
  4. Opis dokumentu, następnie spis treści, Spis rysunków i Spis tabel oraz podział strony.
  5. Każdy element jako nagłówek Word z numerem i nazwą, a następnie jego opis. Style Heading 1 do Heading 6 odpowiadają głębokości; głębsze poziomy pozostają w stylu Heading 6. Tabela Attribute/Value wymienia wybrane kolumny, które mają wartość.
  6. Załączniki: każdy dokument powiązany osadzonym łączem zaczyna się na nowej stronie od “{document} – załącznik” i swojej zawartości, o jeden poziom niżej.

Wygenerowane tabele mogą trafić do sekcji zamiast na początek. Dzieje się tak, gdy dokument ma sekcję o jednej z tych nazw (używają ich wbudowane szablony):

  • Historia zmian: “Revision History” lub “Document Revision History”.
  • Zatwierdzenia: “Approvals”, “Approval”, “Sign-off”, “Signoff”, “Signatures” lub “Signature”.

Podpisy, spisy i odsyłacze

  • Podpisy rysunków (podpis obrazu, rysunek diagramu) mają postać “Rysunek 1: {caption}” pod obrazem. Podpisy tabel (tytuł bloku macierzy, podpis tabeli) mają postać “Tabela 1: {caption}” nad tabelą.
  • Według rozdziałów numeruje je w obrębie sekcji najwyższego poziomu: “Rysunek 3-1” to pierwszy rysunek w sekcji 3. Tabele bez podpisu nie są numerowane.
  • Numery są polami SEQ programu Word, a Spis rysunków i Spis tabel to pola Word oparte na podpisach. Pojawiają się tylko wtedy, gdy dokument ma podpisy rysunków lub tabel. Dopóki Word nie zaktualizuje pól, spisy pokazują podpisy bez numerów stron.
  • Każdy nagłówek, podpis rysunku i podpis tabeli ma zakładkę. Odsyłacz w opisie staje się polem REF programu Word wskazującym zakładkę, więc po aktualizacji pól pokazuje bieżący nagłówek (“3.2 Frost Warning”) lub etykietę (“Rysunek 2-1”). Odsyłacz do elementu, którego nie ma w eksportowanym dokumencie, zachowuje swój tekst.
  • Nagłówki wewnątrz opisów pojawiają się w spisie treści zamienia nagłówki w opisie na prawdziwe nagłówki Word o jeden poziom niżej niż element. Gdy opcja jest wyłączona, pozostają pogrubionymi akapitami.

Ustawienia produktu dostarczanego

Dostarcz ▾ → Ustawienia produktu dostarczanego… przechowuje dane, które zwykle pokazuje produkt dostarczany w ramach umowy. Zastosuj je zapisuje; ⌘Z / Ctrl+Z cofa to w jednym kroku.

PoleGdzie się pojawia
NumeracjaNumery modelu (własne numery elementów) (domyślnie) lub Numery dokumentu (przechowywane tylko w tym dokumencie) (zobacz Numeracja dokumentu).
Strona tytułowaWłącza stronę tytułową (ten sam przełącznik co Strona tytułowa w Ustawieniach strony).
Wersja, Opracował(a)Strona tytułowa i żywa pagina górna (te same pola co w Ustawieniach strony).
Organizacja, Opracowano dla, Numer umowy, Pozycja CDRL, Numer DIDStrona tytułowa. Pozycja CDRL pojawia się też w żywej paginie dolnej.
LogoGóra strony tytułowej. PNG, JPEG lub GIF, do 400 KB.
Informacja na stronie tytułowejRamka u dołu strony tytułowej, np. klauzula dystrybucyjna. Puste: klauzula oznaczenia z Ustawień strony.
Żywa pagina górna i dolnaDomyślnie włączona. Pagina górna pokazuje “{number}, wersja {version}” i tytuł; pagina dolna pokazuje datę, “Strona X z Y” i “CDRL {item}”. Wymaga numeru dokumentu lub wersji.
Planowani zatwierdzającyRola oraz imię i nazwisko każdego zatwierdzającego. Otrzymują linie podpisu, dopóki linia bazowa nie zapisze zatwierdzeń.

Numer dokumentu to pole Nr obok tytułu dokumentu.

Format strony

  • Strona szablonu Word: US Letter lub A4, w pionie lub poziomie, z marginesami 1 cala u góry i u dołu oraz 0,875 cala po bokach.
  • Calibri 11 pt.
  • Prawdziwe style nagłówków, więc okienko nawigacji i spis treści programu Word działają.
  • Wiersze nagłówka tabel są zacieniowane i powtarzane na każdej stronie.
  • Banery strony (oznaczenia) powtarzają się w nagłówku i stopce każdej strony, także strony tytułowej.
  • Ze stroną tytułową plik ma trzy sekcje: stronę tytułową (tylko banery, bez żywej paginy i numeru strony), część wstępną (historia zmian, zatwierdzenia, opis, spis treści i spisy, numerowane i, ii, iii) oraz treść główną (numerowaną od 1; “Strona X z Y” liczy treść główną).
  • Word przy otwieraniu pliku proponuje aktualizację pól. Do tego czasu spis treści pokazuje “Kliknij prawym przyciskiem i wybierz Aktualizuj pole, aby utworzyć spis treści.”

Konwersja tekstu sformatowanego

  • Zachowywane są: pogrubienie, kursywa, podkreślenie, przekreślenie, indeks górny, indeks dolny, kod w tekście (Consolas), wyróżnienie, kolor tekstu i łącza internetowe.
  • Nagłówki wewnątrz opisów stają się pogrubionymi akapitami lub, z opcją powyżej, nagłówkami Word.
  • Listy stają się wciętymi akapitami z “•” lub “1.”.
  • Bloki kodu stają się zacieniowanymi wierszami o stałej szerokości znaków. Cytaty stają się wciętą kursywą.
  • Tabele zachowują scalone kolumny i cieniowanie nagłówka.
  • Obrazy PNG, JPEG i GIF są osadzane, o szerokości do około 6,5 cala, z tekstem alternatywnym jako opisem obrazu. Obrazy SVG i WebP są pomijane w plikach Word.

Zmiany śledzone

Dostarcz ▾ → Zmiany śledzone (Word)… zapisuje dokument ze zmianami śledzonymi programu Word. Wybierz Z linii bazowej i Cel (późniejszą linię bazową lub Bieżący). Zmiany śledzone (Word) w oknie Porównaj wersje robi to samo dla dwóch pokazanych tam wersji.

  • Plik zaczyna się od tabeli Podsumowanie zmian: każda zmiana z raportu zmian, w tym atrybuty, etykiety i relacje.
  • Następnie dokument w wersji docelowej: dodany element jest śledzonym wstawieniem; usunięty element jest śledzonym usunięciem, umieszczonym po elemencie, który był przed nim; zmieniona nazwa lub opis pokazuje usunięte i wstawione słowa.
  • Zmiany akceptuje się lub odrzuca na karcie Recenzja programu Word. Zmienione opisy pojawiają się jako zwykły tekst; niezmienione zachowują formatowanie.
  • Zmiany są przypisywane twórcy docelowej linii bazowej, a w przypadku Bieżący – Tobie.

Drukuj lub PDF… drukuje stronę dokumentu za pomocą przeglądarki. Banery drukują się u góry i u dołu każdej strony. Z żywą paginą (Ustawienia produktu dostarczanego) “{number}, wersja {version}” i tytuł powtarzają się u góry każdej strony, a data i pozycja CDRL u dołu. W kompilacji każda część zaczyna się na nowej stronie. Numery stron, spis treści i numery podpisów są tylko w wyniku Word.

Komentarze

Element komentuje się w jego panelu encji w inspektorze (część Dyskusja). Sprawdź ▾ → Komentarze lub 💬 n otwartych komentarzy w bloku tytułowym pokazuje komentarze w inspektorze:

  • Każdy komentarz do dokumentu i jego elementów, pogrupowany według elementu, z “(otwarte: N)”. Odpowiedzi są wcięte pod komentarzem, na który odpowiadają. Kliknij nazwę elementu, aby go zaznaczyć.
  • Pokaż rozwiązane uwzględnia rozwiązane komentarze.
  • Każdy wątek ma Rozwiąż/Otwórz ponownie przy pierwszym komentarzu, a każdy komentarz ma × (usuń).
  • Aby skomentować sam dokument, wpisz tekst w polu Skomentuj ten dokument… i kliknij Dodaj komentarz.
  • × u góry zamyka komentarze; zaznaczenie elementu pokazuje zamiast nich jego panel encji.
  • Wiersz z nierozwiązanymi komentarzami pokazuje 💬 n; kliknij go, aby otworzyć dyskusję elementu.
  • Komentarze można rozwiązywać, otwierać ponownie i usuwać w obu miejscach.
  • Komentarze (Excel) w oknie Wszystkie eksporty… je zbiera.

Zobacz Komentarze i przeglądy.

Kompilacje

Kompilacja zestawia inne dokumenty. Nowe kompilacje utworzone na stronie Przeglądy lub poleceniem Utwórz pakiet przeglądu mają etykietę Pakiet przeglądu; pakiety utworzone wcześniej mają etykietę Kompilacja i działają tak samo. Zobacz Przeglądy.

Wstaw dokument… dodaje dokument. Polecenie jest w menu Pisz ▾ → Wstaw ▸ i w menu + Nowy ▾.

  • Wymienia dokumenty, które nie zostały jeszcze dołączone.
  • Wstawiony dokument pojawia się jako element najwyższego poziomu, z własną zawartością poniżej. Powiadomienie brzmi “Wstawiono {document}”.
  • Bez innych dokumentów pojawia się komunikat “Brak innych dokumentów do wstawienia.”

Sekcje generowane

Wstaw sekcję generowaną… (w menu Pisz ▾ → Wstaw ▸ i w menu + Nowy ▾) dodaje część, której zawartość jest odbudowywana z modelu przy każdym wyświetleniu lub eksporcie kompilacji.

ZawartośćCo zawiera część
Macierz lub raport z testów…Wstaw otwiera okno Wstaw macierz; wybierz tam macierz (lub raport z testów) i jej zakres. Zakres Kompilacja (wszystkie części) obejmuje każdą część. Pozostaw Nazwa sekcji puste, aby użyć nazwy macierzy.
Lista akronimówTabela elementów Statement z etykietą Acronym (Number, Name), posortowana według numeru.
Tabela zapytaniaTabela encji pasujących do pola Zapytanie, z wymienionymi Kolumny (nazwy atrybutów rozdzielone przecinkami).

Część jest numerowana po ostatniej części, więc dokumenty części zachowują swoje numery. ⌘Z / Ctrl+Z usuwa ją w jednym kroku. Bez nazwy pojawia się komunikat “Wpisz nazwę sekcji.”; tabela zapytania bez zapytania lub kolumn pokazuje “Wpisz zapytanie i co najmniej jedną kolumnę.”

Kompilacja w Wordzie

Eksport kompilacji do formatu Word eksportuje każdy element najwyższego poziomu jako część:

  • Nagłówek części brzmi “Część A: {document}” (Heading 1), z wierszem z typem dokumentu, numerem i przypiętą linią bazową.
  • Numery sekcji wewnątrz części otrzymują literę części: “A.1 Scope”, “B.1 Scope”. Żaden numer sekcji się nie powtarza.
  • Każda część po pierwszej zaczyna się na nowej stronie.
  • Z podpisami Według rozdziałów rysunki w części B mają postać “Rysunek B-1”.

Ustawienia produktu dostarczanego… w kompilacji dodaje sekcję Części kompilacji:

UstawienieWybory
Etykiety częściCzęść A, Część B, … (domyślnie), Tom 1, Tom 2, …, Załącznik A, Załącznik B, … lub Bez etykiet części
Numery sekcjiW obrębie części, z literą lub numerem części (A.1, B.1) (domyślnie), Ciągła we wszystkich częściach (1, 2, 3) lub Każdy dokument ma własne numery
Każda część od nowej stronyDomyślnie włączone
Strona tytułowa dla każdej częściNagłówek części i jego wiersz na osobnej stronie
Eksportuj każdą część zBieżący lub jednej z linii bazowych dokumentu części. Przypięta część pokazuje w swoim wierszu 📌 i nazwę linii bazowej, a eksportuje zawartość tej linii bazowej.

Narzędzia AI

✦ AI ▾ na górnym pasku wymienia narzędzia AI dla zaznaczenia i dokumentu. Każdy wynik AI jest najpierw pokazywany w podglądzie, a jedno polecenie Cofnij wycofuje całość. W linii bazowej narzędzia są wyłączone. Zobacz AI.

  • Dla zaznaczonego elementu Requirement lub Statement: Przeredaguj przejrzyściej…, Dodaj mierzalne kryteria… (wymagania), Uprość…, Podziel wymaganie złożone…, Zredaguj uzasadnienie…, Sugeruj nazwę…, Sprawdź z AI (to wymaganie)…, Generuj wymagania podrzędne… i Generuj przypadek testowy… (wymagania).
  • Dla dowolnego zaznaczonego elementu: Generuj ryzyka….
  • Dla dokumentu: Generuj wymagania…, Podsumuj dokument…, Przetłumacz dokument… i Sprawdź z AI (N wymagań)….

Skróty klawiszowe

KlawiszeCzynność
⌘F / Ctrl+FWyszukiwanie w dokumencie
Enter / Shift+EnterNastępne / poprzednie dopasowanie (w polu wyszukiwania)
⌘↵ / Ctrl↵Dodaj element po zaznaczonym
⌥⌘↵ / Ctrl+Alt↵Dodaj element podrzędny zaznaczonego elementu
⌥⇧→ / Alt+Shift+→ / ⌥⇧← / Alt+Shift+←Zwiększ / zmniejsz wcięcie zaznaczonego elementu
⌥ / Alt+↑ / ⌥ / Alt+↓Przenieś zaznaczony element w górę / w dół
↑ / ↓Zaznacz poprzedni / następny wiersz; fokus przechodzi razem z zaznaczeniem
TabNastępne pole: zaznaczony wiersz, potem jego numer, nazwa i opis
Enter / F2Na wierszu: edytuj jego nazwę; na numerze, nazwie lub opisie: edytuj je
Delete lub BackspaceUsuń zaznaczone elementy z dokumentu (Cofnij w komunikacie)
⇧Delete / Shift+DeleteUsuń zaznaczone elementy i ich elementy podrzędne po potwierdzeniu
EscUsuń zaznaczenie; w polu wyszukiwania wyczyść wyszukiwanie
Enter / EscZapisz / anuluj edycję numeru lub nazwy (fokus pozostaje w polu)
↑ ↓ Home End w konspekciePoruszanie się po elementach konspektu
→ / ← w konspekcieRozwiń / zwiń element albo przejdź do jego pierwszego elementu podrzędnego / jego elementu nadrzędnego
Enter / Space w konspekcieOtwórz element w dokumencie (fokus przechodzi do jego wiersza) / zaznacz go
⌘Z / Ctrl+Z / ⇧⌘Z / Ctrl+Shift+ZCofnij / ponów (poza edytorem)

W systemach Windows i Linux zamiast ⌘ / Ctrl używaj Ctrl, a zamiast ⌥ / Alt – Alt. Skróty wierszy działają, gdy żadne pole nie ma fokusu. ⌘↵ / Ctrl↵ i ⌥⌘↵ / Ctrl+Alt↵ działają także podczas edycji numeru lub nazwy. Zobacz Skróty klawiaturowe oraz klawisze edytora tekstu sformatowanego powyżej.

Ustawienia zapamiętywane w tej przeglądarce

Przechowywane w tej przeglądarce:

  • Czy okienko konspektu jest ukryte oraz jego szerokość.
  • Kolumny i szerokości kolumn dla każdego dokumentu.
  • Sortowanie listy.
  • Bieżąca klasa nowych elementów.
  • Ostatni typ raportu.
  • Szablony zapisane przed wersją 1.8.0, dopóki nie zaimportujesz ich do projektu.

Zapisywane z dokumentem i udostępniane wszystkim w projekcie: Papier, Status śledzenia, szablon Word, numeracja dokumentu, wzorzec numeracji i pierwszy numer oraz automatyczne przenumerowywanie. Szablony Word projektu są zapisywane z projektem.

Komunikaty

WiadomośćZnaczenie i rozwiązanie
Brak dokumentów / “Utwórz dokument przyciskiem + Nowy dokument lub zaimportuj plik Word, Excel, CSV albo ReqIF przyciskiem Importuj.”Projekt nie ma jeszcze dokumentów.
“Żaden dokument nie pasuje. Wyczyść wyszukiwanie lub wybierz Wszystkie.”Wyczyść pole Szukaj dokumentów… lub kliknij Wszystkie.
Nie znaleziono dokumentuAdres wskazuje usunięty dokument. Użyj przycisku Wróć do dokumentów.
Ten dokument jest pusty / “Dodaj wymaganie przyciskiem “+ Nowe wymaganie” lub wypełnij dokument z szablonu poleceniem Pisz → Zastosuj szablon….”Dodaj elementy lub zastosuj szablon.
“Żaden element nie pasuje do filtru. Wyczyść filtr, aby zobaczyć wszystkie elementy.”Zmień lub wyczyść etykiety filtrów klas i etykiet.
Widok filtrowany: edycja jest wyłączona. Wyczyść filtr / “Wyczyść filtr lub sortowanie, aby dodać elementy”Tworzenie treści jest wstrzymane; kliknij ostrzeżenie, aby je wyczyścić.
“Najpierw wpisz tekst.”Szybkie dodawanie zostało wysłane bez treści.
“Wybranego elementu nie można przesunąć dalej w tym kierunku.”Element jest pierwszy lub ostatni, zablokowany albo sąsiaduje z zablokowanym elementem.
“Element nie może znaleźć się pod własnym elementem podrzędnym. Wybierz inny element nadrzędny.”Wybierz cel spoza poddrzewa elementu.
Nieaktualne (kolumna Quality Score)Tekst zmienił się po ostatniej kontroli jakości. Uruchom ją ponownie.
“Nie udało się załadować szablonów dokumentów.”Nie udało się załadować katalogu szablonów; załaduj ponownie stronę.
“Podgląd pokazuje tylko eksporty arkuszy kalkulacyjnych. Wybierz eksport do Excela.”Podgląd działa tylko dla raportów Excel.
“Ten dokument nie ma linii bazowej. Najpierw ją zapisz.”Przed uruchomieniem raportów zmian utwórz linię bazową.
“Eksport nie powiódł się: … Sprawdź szablon Word i wyeksportuj ponownie.”Eksport do Worda jednym kliknięciem nie powiódł się; sprawdź szablon w oknie Edytuj szablony Word….
“Obraz przekracza limit N MB.” / “Plik przekracza limit N MB.”Plik jest większy niż limit serwera dla pojedynczego pliku.

Limity

Limit: nazwy edytowane w wierszu dokumentu mogą mieć do 200 znaków, a numery do 139. Szybkie dodawanie przyjmuje 2000 znaków.

Limit: obrazy są zmniejszane do 4000 px na dłuższym boku. Dołączone pliki i obrazy ogranicza limit serwera dla pojedynczego pliku (10 MB w planie Free, 25 MB w Individual, 100 MB w Team) oraz przydział miejsca projektu.

Limit: wynik Word osadza tylko obrazy PNG, JPEG i GIF. Poziomy nagłówków głębsze niż 6 są pokazywane jako Heading 6.

Limit: szablony organizacji istnieją na serwerach Holarch (hostowanych lub samodzielnie hostowanych), a nie w aplikacji desktopowej; aplikacja desktopowa przechowuje szablony projektu w pliku projektu. Organizacja może mieć do 200 szablonów po maksymalnie 3000 sekcji. Szablony zapisane w jednym projekcie nie są oferowane w innych projektach: zapisz szablon w organizacji lub zapisz go ponownie w drugim projekcie.