Kurskapitel
Schulung · Reihe 1. Erste Schritte · Kapitel 1.5 von 8
1.5 Dokumente 2:46
Eine Spezifikation schreiben, deren Anforderungen Modellelemente sind.
Zeigt Holarch 1.27.
Das lernen Sie
- Eine Anforderungsspezifikation aus einer integrierten Vorlage erstellen
- Eine Anforderung unter einem Abschnitt hinzufügen und ihre Shall-Aussage schreiben
- Mit „Schnell hinzufügen“ rasch mehrere Anforderungen hinzufügen
- Die Anforderungen eines Dokuments als Modellelemente in der Datenbank finden
- Die Spezifikation über das Menü „Liefern“ nach Word exportieren
Erstellen Sie die Systemanforderungsspezifikation des Bike-Share Dock aus einer integrierten Vorlage, schreiben Sie mit + Untergeordnet und dem Inspektor eine Anforderung unter einem Abschnitt, fügen Sie mit „Schnell hinzufügen“ weitere hinzu, sehen Sie, dass jede Anforderung im Dokument ein Modellelement in der Datenbank ist, und exportieren Sie das Dokument nach Word.
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.
- Öffnen Sie Ihr EO-1-Demoprojekt (oder erstellen Sie es: Projekte verwalten → Projektdateien ▾ → Neues Demoprojekt → CubeSat (Geführtes Systems Engineering)).
- Öffnen Sie Bedarfe & Anforderungen → Dokumente und klicken Sie auf + Neues Dokument. Nennen Sie es
EO-1 Ground Station Specification, wählen Sie die Vorlage Requirements Specification und klicken Sie auf Erstellen. - Wählen Sie den Abschnitt 4.1 Primary Functions aus, klicken Sie auf + Untergeordnet, nennen Sie die Anforderung
Track the Spacecraftund schreiben Sie ihre Shall-Aussage in die Beschreibung im Inspektor. - Wählen Sie unten in Schnell hinzufügen Unter 10 Design Constraints, geben Sie
The ground station antenna shall have a diameter of no more than 3.7 m.ein und drücken Sie die Eingabetaste. Fügen Sie auf dieselbe Weise eine zweite Randbedingung hinzu. - Öffnen Sie die Datenbank und geben Sie
in:"EO-1 Ground Station Specification" class:Requirementin das Suchfeld ein, um die neuen Anforderungen aufzulisten. - Wählen Sie zurück im Dokument Liefern ▾ → Spezifikation (Word) und öffnen Sie die Datei.
Sie sind fertig, wenn die Word-Datei Ihre drei Anforderungen unter ihren nummerierten Abschnitten zeigt.
Selbsttest
- Was ist der Unterschied zwischen einer Anforderung, die in ein Holarch-Dokument getippt wird, und einer, die in ein Textverarbeitungsprogramm getippt wird?
- Wie wählt „Schnell hinzufügen“ den Namen der neuen Anforderung?
- Wann würden Sie „Schreibhinweise einbeziehen“ aktivieren?
Antworten anzeigen
Was ist der Unterschied zwischen einer Anforderung, die in ein Holarch-Dokument getippt wird, und einer, die in ein Textverarbeitungsprogramm getippt wird?
In Holarch ist jede Anforderung im Dokument ein Modellelement: Sie können sie nachverfolgen, ihre Qualität prüfen, sie in Diagrammen darstellen und in der Datenbank finden.
Wie wählt „Schnell hinzufügen“ den Namen der neuen Anforderung?
Sie benennt die Anforderung nach den Wörtern nach shall und nummeriert sie im gewählten Abschnitt nach ihren Geschwistern.
Wann würden Sie „Schreibhinweise einbeziehen“ aktivieren?
Wenn die Autoren den Dokumenttyp noch nicht kennen: Jeder Abschnitt erhält dann einen kurzen Hinweis, was er enthalten soll, den Sie beim Schreiben löschen.
Weiterlesen
Transkript
Transkript anzeigen (Erzählung und Bildschirminhalt)
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.