Holarch
Kurskapitel

Schulung · Reihe 4. Dokumente und Liefergegenstände · Kapitel 4.1 von 5

4.1 Dokumentvorlagen 2:54

Einen Plan oder eine Spezifikation aus einer Vorlage beginnen, mit Hinweisen für jeden Abschnitt.

Zeigt Holarch 2.13.

Alle Kapitel · 4.2 Live-Matrizen in Dokumenten →

Das lernen Sie

  • Ein Dokument eines gewählten Typs aus einer integrierten Vorlage erstellen
  • Schreibhinweise einbeziehen und die Hinweise in einem Abschnitt lesen
  • Die Hinweise eines Abschnitts durch eigenen Text ersetzen und speichern
  • Erklären, warum jeder Dokumentabschnitt ein Modellelement ist

Erstellen Sie den Systems-Engineering-Managementplan des Bike-Share Dock aus einer integrierten Vorlage: Dokumenttyp wählen, die Gliederung mit der Vorlage mit Hinweisen vergleichen, die Hinweise in jedem Abschnitt lesen, sie durch eigenen Text ersetzen und sehen, dass jeder Abschnitt ein Modellelement ist.

Projektdateien

  • Startprojekt (.holarch.json; Projekte verwalten → Projektdateien ▾ → Projekt importieren (.json)…)
  • Fertiges Projekt (.holarch.json; Projekte verwalten → Projektdateien ▾ → Projekt importieren (.json)…)

Das Video wird von holarch.app abgespielt; siehe Datenschutzerklärung.

Übung

Führen Sie dies selbst in Holarch durch, am Demoprojekt CubeSat EO-1.

  1. Öffnen Sie Ihr EO-1-Demoprojekt oder erstellen Sie es: Projekte verwalten → Projektdateien ▾ → Neues Demoprojekt → CubeSat (Geführtes Systems Engineering).
  2. Öffnen Sie Bedarfe & Anforderungen → Dokumente und klicken Sie auf + Neues Dokument. Nennen Sie es EO-1 Interface Control Document.
  3. Wählen Sie unter Vorlagen für Interface Control Document, aktivieren Sie Schreibhinweise einbeziehen, wählen Sie die Karte Interface Control Document (ICD) und klicken Sie auf Erstellen.
  4. Wählen Sie den Abschnitt 2.3 Interface Owners and Change Authority aus und lesen Sie seine Hinweise. Klicken Sie auf seine Beschreibung, ersetzen Sie die Hinweise durch die Verantwortlichen der EO-1-Schnittstellen (zum Beispiel Payload Lead und Comms Lead) und drücken Sie ⌘ / Ctrl↵, um zu speichern.
  5. Wählen Sie den Abschnitt 3.2 Interface Matrix aus und lesen Sie die Live-Schnittstellenmatrix, die die Vorlage dort eingefügt hat.
  6. Für eine geprüfte Schritt-für-Schritt-Anleitung führen Sie Tutorial 11 Produce the Deliverable aus (Hilfe → Tutorials).

Sie sind fertig, wenn das neue ICD in 2.3 Ihren eigenen Text statt der Hinweise zeigt und 3.2 eine Matrix der EO-1-Komponenten zeigt.

Selbsttest

  1. Was entscheidet, welche Vorlagen „Neues Dokument“ zuerst anbietet?
  2. Was ist der Unterschied zwischen einer Vorlage mit und ohne Schreibhinweise?
  3. Warum ist es wichtig, dass jeder Abschnitt ein Modellelement ist?
Antworten anzeigen
  1. Was entscheidet, welche Vorlagen „Neues Dokument“ zuerst anbietet?

    Der unter „Vorlagen für“ gewählte Dokumenttyp. Vorlagen anderer Typen werden weiterhin unter „Weitere Vorlagen“ aufgeführt; das Dokument erhält den Typ der Vorlage, die Sie wählen.

  2. Was ist der Unterschied zwischen einer Vorlage mit und ohne Schreibhinweise?

    Beide liefern dieselben nummerierten Abschnitte und Starttabellen. Mit Hinweisen beginnt jeder Abschnitt außerdem mit einer kurzen Anleitung, was er enthalten soll, die Sie beim Schreiben ersetzen.

  3. Warum ist es wichtig, dass jeder Abschnitt ein Modellelement ist?

    Ein Abschnitt ist ein Statement, daher können Sie ihn wie eine Anforderung verknüpfen, kommentieren und in eine Baseline aufnehmen, und das Dokument bleibt eine Ansicht des Modells.

Weiterlesen

Transkript

Transkript anzeigen (Erzählung und Bildschirminhalt)

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.