Holarch
Capitoli del corso

Formazione · Percorso 1. Primi passi · Capitolo 1.5 di 8

1.5 Documenti 2:46

Scrivere una specifica i cui requisiti sono elementi del modello.

Mostra Holarch 1.27.

← 1.4 Il primo diagramma · Tutti i capitoli · 1.6 Trovare ciò che serve →

Che cosa si impara

  • Creare una specifica dei requisiti da un modello integrato
  • Aggiungere un requisito sotto una sezione e scriverne l’enunciato con shall
  • Aggiungere rapidamente più requisiti con Aggiunta rapida
  • Trovare i requisiti di un documento nel Database come elementi del modello
  • Esportare la specifica in Word dal menu Consegna

Creare la specifica dei requisiti di sistema della Bike-Share Dock da un modello integrato, scrivere un requisito sotto una sezione con + Figlio e l’ispettore, aggiungerne altri con Aggiunta rapida, verificare che ogni requisito del documento è un elemento del modello nel Database ed esportare il documento in Word.

File di progetto

  • Progetto iniziale (.holarch.json; Gestisci progetti → File di progetto ▾ → Importa progetto (.json)…)
  • Progetto completato (.holarch.json; Gestisci progetti → File di progetto ▾ → Importa progetto (.json)…)

Il video viene riprodotto da holarch.app; vedere l’Informativa sulla privacy.

Esercitazione

Provare in prima persona in Holarch, sul progetto demo CubeSat EO-1.

  1. Aprire il proprio progetto demo EO-1 (oppure crearlo: Gestisci progetti → File di progetto ▾ → Nuovo progetto demo → CubeSat (ingegneria dei sistemi guidata)).
  2. Aprire Esigenze e requisiti → Documenti e fare clic su + Nuovo documento. Chiamarlo EO-1 Ground Station Specification, scegliere il modello Specifica dei requisiti e fare clic su Crea.
  3. Selezionare la sezione 4.1 Primary Functions, fare clic su + Figlio, chiamare il requisito Track the Spacecraft e scriverne l’enunciato con shall nella descrizione dell’ispettore.
  4. In Aggiunta rapida in basso, scegliere Sotto 10 Design Constraints, digitare The ground station antenna shall have a diameter of no more than 3.7 m. e premere Enter. Aggiungere allo stesso modo un secondo vincolo.
  5. Aprire il Database e digitare in:"EO-1 Ground Station Specification" class:Requirement nella casella di ricerca per elencare i nuovi requisiti.
  6. Tornati nel documento, scegliere Consegna ▾ → Specifica (Word) e aprire il file.

L’esercizio è completato quando il file Word mostra i tre requisiti sotto le rispettive sezioni numerate.

Verifica

  1. Qual è la differenza tra un requisito digitato in un documento Holarch e uno digitato in un elaboratore di testi?
  2. Come sceglie Aggiunta rapida il nome del nuovo requisito?
  3. Quando conviene spuntare Includi indicazioni di scrittura?
Mostra le risposte
  1. Qual è la differenza tra un requisito digitato in un documento Holarch e uno digitato in un elaboratore di testi?

    In Holarch ogni requisito del documento è un elemento del modello: lo si può tracciare, controllarne la qualità, disegnarlo nei diagrammi e trovarlo nel Database.

  2. Come sceglie Aggiunta rapida il nome del nuovo requisito?

    Dà al requisito un nome tratto dalle parole dopo shall e lo numera dopo i suoi fratelli nella sezione scelta.

  3. Quando conviene spuntare Includi indicazioni di scrittura?

    Quando gli autori non conoscono ancora il tipo di documento: ogni sezione riceve allora una breve nota su ciò che deve contenere, che si elimina scrivendo.

Per saperne di più

Trascrizione

Mostra la trascrizione (narrazione e contenuto dello schermo)

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.