Capitoli del corso
Formazione · Percorso 4. Documenti e deliverable · Capitolo 4.1 di 5
4.1 Modelli di documento 2:54
Iniziare un piano o una specifica da un modello, con indicazioni per ogni sezione.
Mostra Holarch 2.13.
Che cosa si impara
- Creare un documento di un tipo scelto da un modello integrato
- Includere le indicazioni di scrittura e leggere le indicazioni di una sezione
- Sostituire le indicazioni di una sezione con il proprio testo e salvarlo
- Spiegare perché ogni sezione del documento è un elemento del modello
Creare il piano di gestione dell’ingegneria dei sistemi della Bike-Share Dock da un modello integrato: scegliere il tipo di documento, confrontare lo schema e il modello guidato, leggere le indicazioni in ogni sezione, sostituirle con il proprio testo e verificare che ogni sezione è un elemento del modello.
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.
- Aprire il proprio progetto demo EO-1, oppure crearlo: Gestisci progetti → File di progetto ▾ → Nuovo progetto demo → CubeSat (ingegneria dei sistemi guidata).
- Aprire Esigenze e requisiti → Documenti e fare clic su + Nuovo documento. Chiamarlo
EO-1 Interface Control Document. - In Modelli per, scegliere Documento di controllo dell’interfaccia, spuntare Includi indicazioni di scrittura, scegliere la scheda Documento di controllo dell’interfaccia (ICD) e fare clic su Crea.
- Selezionare la sezione 2.3 Interface Owners and Change Authority e leggerne le indicazioni. Fare clic sulla sua descrizione, sostituire le indicazioni con i proprietari delle interfacce di EO-1 (ad esempio il Payload Lead e il Comms Lead) e premere ⌘ / Ctrl↵ per salvare.
- Selezionare la sezione 3.2 Interface Matrix e leggere la matrice dinamica delle interfacce che il modello vi ha inserito.
- Per una procedura guidata con verifica, eseguire il tutorial 11 Produrre il deliverable (Guida → Tutorial).
L’esercizio è completato quando il nuovo ICD mostra il proprio testo in 2.3 invece delle indicazioni, e 3.2 mostra una matrice dei componenti di EO-1.
Verifica
- Che cosa decide quali modelli Nuovo documento propone per primi?
- Qual è la differenza tra un modello con e senza indicazioni di scrittura?
- Perché è importante che ogni sezione sia un elemento del modello?
Mostra le risposte
Che cosa decide quali modelli Nuovo documento propone per primi?
Il tipo di documento scelto in Modelli per. I modelli di altri tipi restano elencati in Altri modelli; il documento assume il tipo del modello scelto.
Qual è la differenza tra un modello con e senza indicazioni di scrittura?
Entrambi forniscono le stesse sezioni numerate e le stesse tabelle iniziali. Con le indicazioni, ogni sezione inizia anche con una breve guida a ciò che deve contenere, che si sostituisce scrivendo.
Perché è importante che ogni sezione sia un elemento del modello?
Una sezione è uno Statement, quindi la si può collegare, commentare e mettere in baseline come un requisito, e il documento resta una vista del modello.
Per saperne di più
Trascrizione
Mostra la trascrizione (narrazione e contenuto dello schermo)
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.