Rozdziały kursu
Szkolenia · Ścieżka 1. Pierwsze kroki · Rozdział 1.5 z 8
1.5 Dokumenty 2:46
Napisz specyfikację, której wymagania są elementami modelu.
Pokazuje Holarch 1.27.
Czego się nauczysz
- Tworzenie specyfikacji wymagań z wbudowanego szablonu
- Dodawanie wymagania pod sekcją i pisanie jego zdania z „shall”
- Szybkie dodawanie kilku wymagań za pomocą Szybkiego dodawania
- Znajdowanie wymagań dokumentu w Bazie danych jako elementów modelu
- Eksportowanie specyfikacji do Word z menu Dostarcz
Utwórz specyfikację wymagań systemowych stacji Bike-Share Dock z wbudowanego szablonu, napisz wymaganie pod sekcją za pomocą + Podrzędny i inspektora, dodaj kolejne za pomocą Szybkiego dodawania, zobacz, że każde wymaganie w dokumencie jest elementem modelu w Bazie danych, i wyeksportuj dokument do Word.
Pliki projektu
- Projekt początkowy (.holarch.json; Zarządzaj projektami → Pliki projektu ▾ → Importuj projekt (.json)…)
- Projekt ukończony (.holarch.json; Zarządzaj projektami → Pliki projektu ▾ → Importuj projekt (.json)…)
Film jest odtwarzany z holarch.app; zobacz Politykę prywatności.
Ćwiczenie
Wykonaj to samodzielnie w Holarch, w projekcie demonstracyjnym CubeSat EO-1.
- Otwórz swój projekt demonstracyjny EO-1 (lub go utwórz: Zarządzaj projektami → Pliki projektu ▾ → Nowy projekt demonstracyjny → CubeSat (inżynieria systemów z przewodnikiem)).
- Otwórz Potrzeby i wymagania → Dokumenty i kliknij + Nowy dokument. Nazwij go
EO-1 Ground Station Specification, wybierz szablon Specyfikacja wymagań i kliknij Utwórz. - Zaznacz sekcję 4.1 Primary Functions, kliknij + Podrzędny, nazwij wymaganie
Track the Spacecrafti napisz jego zdanie z „shall” w opisie w inspektorze. - W polu Szybkie dodawanie na dole wybierz Pod 10 Design Constraints, wpisz
The ground station antenna shall have a diameter of no more than 3.7 m.i naciśnij Enter. W ten sam sposób dodaj drugie ograniczenie. - Otwórz Bazę danych i wpisz w polu wyszukiwania
in:"EO-1 Ground Station Specification" class:Requirement, aby wyświetlić nowe wymagania. - Po powrocie do dokumentu wybierz Dostarcz ▾ → Specyfikacja (Word) i otwórz plik.
Gotowe, gdy plik Word pokazuje twoje trzy wymagania pod ich numerowanymi sekcjami.
Sprawdź się
- Czym różni się wymaganie wpisane w dokumencie Holarch od wymagania wpisanego w edytorze tekstu?
- Jak Szybkie dodawanie wybiera nazwę nowego wymagania?
- Kiedy zaznaczyć Uwzględnij wskazówki redakcyjne?
Pokaż odpowiedzi
Czym różni się wymaganie wpisane w dokumencie Holarch od wymagania wpisanego w edytorze tekstu?
W Holarch każde wymaganie w dokumencie jest elementem modelu: można je powiązać, sprawdzić jego jakość, narysować na diagramach i znaleźć w Bazie danych.
Jak Szybkie dodawanie wybiera nazwę nowego wymagania?
Nadaje wymaganiu nazwę ze słów po „shall” i numeruje je po elementach równorzędnych w wybranej sekcji.
Kiedy zaznaczyć Uwzględnij wskazówki redakcyjne?
Gdy autorzy nie znają jeszcze danego typu dokumentu: każda sekcja dostaje wtedy krótką notatkę o tym, co powinna zawierać, którą usuwasz w trakcie pisania.
Więcej informacji
Transkrypcja
Pokaż transkrypcję (narracja i to, co widać na ekranie)
Introduction
Chapter five: documents. Requirements usually live in a specification. In Holarch a document is an outline of model items, so every requirement in it is an item you can trace, check and draw.
We continue with the Bike-Share Dock project, and write its system requirements specification.
Create from a template
Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
Name it Bike-Share Dock System Requirements. The templates below are for requirements documents; the menu next to them shows the templates for other kinds of document.
On screen: New Document: name; templates for Requirements Document.
A template gives the document its sections. Include writing guidance adds notes that explain what each section should hold. Choose Requirements Specification, with the sections only, and click Create.
On screen: Template: Requirements Specification → Create.
The document opens with the template's numbered sections, from document control to the appendices. The outline on the left lists them, and clicking an entry jumps to it.
On screen: The new document and its outline.
Write requirements
Select section 4.1, Primary Functions. Open the menu next to After, and choose Add Child. A new requirement appears under the section, numbered 4.1.1, with its name ready to type. Type Show Available Bikes, and press Enter.
On screen: 4.1 → + After ▾ → Add Child → Show Available Bikes.
Then write the shall statement. Click the description in the inspector, type it, and click elsewhere to save.
On screen: Inspector → Description.
To add many requirements quickly, use Quick add at the bottom of the document. Choose the section Design Constraints, type the requirement, and click Add, or press Enter.
On screen: Quick add → Under 10. Design Constraints → Add.
Holarch adds it under the section, and names it from the words after shall. The cursor stays in the field, so the next requirement is one more line.
On screen: Second Quick add.
One model
Each requirement in the document is a model item. Open the Database and filter to requirements: the new ones are listed with the requirements from chapter two.
On screen: Database → + Filter → Requirement.
Export
Back in the document, the Deliver menu makes the Word file: the specification with a table of contents and the numbered requirements, ready to send for review. Choose Specification (Word).
On screen: Back to the document → Deliver ▾ → Specification (Word).
Recap
Let's recap. You created a specification from a template, wrote a requirement under a section, added more with Quick add, saw that they are model items, and exported the document to Word.
Next, you learn the quickest ways to find anything in a growing model.