Holarch
Rozdziały kursu

Szkolenia · Ścieżka 4. Dokumenty i produkty końcowe · Rozdział 4.1 z 5

4.1 Szablony dokumentów 2:54

Zacznij plan lub specyfikację od szablonu, ze wskazówkami do każdej sekcji.

Pokazuje Holarch 2.13.

Wszystkie rozdziały · 4.2 Macierze na żywo w dokumentach →

Czego się nauczysz

  • Tworzenie dokumentu wybranego typu z wbudowanego szablonu
  • Dołączanie wskazówek redakcyjnych i odczytywanie wskazówek w sekcji
  • Zastępowanie wskazówek sekcji własnym tekstem i zapisywanie go
  • Dlaczego każda sekcja dokumentu jest elementem modelu

Utwórz plan zarządzania inżynierią systemów stacji Bike-Share Dock z wbudowanego szablonu: wybierz typ dokumentu, porównaj konspekt i szablon ze wskazówkami, przeczytaj wskazówki w każdej sekcji, zastąp je własnym tekstem i zobacz, że każda sekcja jest elementem modelu.

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.

  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).
  2. Otwórz Potrzeby i wymagania → Dokumenty i kliknij + Nowy dokument. Nazwij go EO-1 Interface Control Document.
  3. W sekcji Szablony dla wybierz Dokument kontroli interfejsów, zaznacz Uwzględnij wskazówki redakcyjne, wybierz kartę Dokument kontroli interfejsów (ICD) i kliknij Utwórz.
  4. Zaznacz sekcję 2.3 Interface Owners and Change Authority i przeczytaj jej wskazówki. Kliknij jej opis, zastąp wskazówki właścicielami interfejsów EO-1 (na przykład Payload Lead i Comms Lead) i naciśnij ⌘ / Ctrl↵, aby zapisać.
  5. Zaznacz sekcję 3.2 Interface Matrix i odczytaj macierz interfejsów na żywo, którą umieścił tam szablon.
  6. Aby przejść całość ze sprawdzaniem, uruchom samouczek 11 Opracowanie produktu (Pomoc → Samouczki).

Gotowe, gdy nowy ICD pokazuje w 2.3 twój własny tekst zamiast wskazówek, a 3.2 pokazuje macierz komponentów EO-1.

Sprawdź się

  1. Od czego zależy, które szablony Nowy dokument proponuje najpierw?
  2. Czym różni się szablon ze wskazówkami redakcyjnymi od szablonu bez nich?
  3. Dlaczego ważne jest, że każda sekcja jest elementem modelu?
Pokaż odpowiedzi
  1. Od czego zależy, które szablony Nowy dokument proponuje najpierw?

    Od typu dokumentu wybranego w sekcji Szablony dla. Szablony innych typów są nadal wymienione w sekcji Inne szablony; dokument otrzymuje typ wybranego szablonu.

  2. Czym różni się szablon ze wskazówkami redakcyjnymi od szablonu bez nich?

    Oba dają te same numerowane sekcje i tabele startowe. Ze wskazówkami każda sekcja zaczyna się też od krótkiego opisu tego, co powinna zawierać, który zastępujesz w trakcie pisania.

  3. Dlaczego ważne jest, że każda sekcja jest elementem modelu?

    Sekcja jest elementem Statement, więc można ją powiązać, komentować i objąć linią bazową jak wymaganie, a dokument pozostaje widokiem modelu.

Więcej informacji

Transkrypcja

Pokaż transkrypcję (narracja i to, co widać na ekranie)

Introduction

Welcome to track four: documents and deliverables. Programs are reviewed through their documents: plans, specifications, and the matrices reviewers ask for. In Holarch, these are built from the model. This first chapter covers document templates.

You will pick a document type and its template, compare an outline with a template that has guidance, and write your own text over that guidance.

Choose a type

We continue with the Bike-Share Dock. It already has requirements, functions, parts and test cases. Open Needs and Requirements, then Documents, and click New Document.

On screen: Needs & Requirements → Documents → + New Document.

The type decides which templates are offered. Holarch has templates for the documents most programs write, from the concept of operations to the test plan, and for the concept stage: needs analysis, concept exploration and concept definition.

On screen: Card: document types with templates.

Name it Bike-Share Dock SEMP. Then, under Templates for, choose Systems Engineering Management Plan Document.

On screen: Name, then Templates for ▾ → Systems Engineering Management Plan Document.

Outline or guidelines

Each template comes in two forms. The outline has only the section headings. With writing guidance, every section also explains what it should hold, with an example. Tick Include writing guidance, choose the template, and click Create.

On screen: Include writing guidance → the template card → Create.

The plan opens with fifteen numbered sections: the life cycle, the technical reviews, requirements management, baselines, interfaces, verification, risk, and the tools and model.

On screen: The new plan and its outline.

Write your plan

Click section 2.1, Purpose. Its text is the guidance: state why this plan exists and who uses it, followed by an example.

On screen: Outline → 2.1 Purpose.

Replace the guidance with your own text. Click the description to edit it, select its text, and type the purpose of this plan. Then press Command Return to save it.

On screen: Edit 2.1's description → type → Save.

The guidance often points to where the work lives in Holarch. Section 8.1, Baselines, says to use Holarch baselines, so that later changes can be compared against them. Chapter four of this track shows how.

On screen: Outline → 8.1 Baselines.

Every section is a model item, a statement, so you can link it, comment on it and baseline it, like a requirement.

On screen: 8.1's class badge: Statement.

Recap

Let's recap. You chose a document type and its template, picked the template with guidelines, read the guidance in a section, and replaced it with your own text.

Next, you put live traceability and verification matrices into a document.