Chapitres du cours
Formation · Parcours 4. Documents et livrables · Chapitre 4.1 sur 5
4.1 Modèles de documents 2:54
Démarrer un plan ou une spécification à partir d'un modèle, avec des consignes pour chaque section.
Montre Holarch 2.13.
Ce que vous allez apprendre
- Créer un document d'un type choisi à partir d'un modèle intégré
- Inclure les consignes de rédaction et lire les consignes d'une section
- Remplacer les consignes d'une section par votre propre texte et l'enregistrer
- Expliquer pourquoi chaque section de document est un élément du modèle
Créez le plan de management de l'ingénierie système du Bike-Share Dock à partir d'un modèle intégré : choisissez le type de document, comparez le plan simple et le modèle guidé, lisez les consignes de chaque section, remplacez-les par votre propre texte, et constatez que chaque section est un élément du modèle.
Fichiers de projet
- Projet de départ (.holarch.json ; Gérer les projets → Fichiers de projet ▾ → Importer un projet (.json)…)
- Projet terminé (.holarch.json ; Gérer les projets → Fichiers de projet ▾ → Importer un projet (.json)…)
La vidéo est diffusée depuis holarch.app ; voir la Politique de confidentialité.
Pratique
Faites-le vous-même dans Holarch, sur le projet de démonstration CubeSat EO-1.
- Ouvrez votre projet de démonstration EO-1, ou créez-le : Gérer les projets → Fichiers de projet ▾ → Nouveau projet de démonstration → CubeSat (ingénierie système guidée).
- Ouvrez Besoins et exigences → Documents et cliquez sur + Nouveau document. Nommez-le
EO-1 Interface Control Document. - Sous Modèles pour, choisissez Interface Control Document, cochez Inclure les consignes de rédaction, choisissez la carte Interface Control Document (ICD) et cliquez sur Créer.
- Sélectionnez la section 2.3 Interface Owners and Change Authority et lisez ses consignes. Cliquez sur sa description, remplacez les consignes par les responsables des interfaces EO-1 (par exemple le Payload Lead et le Comms Lead), et appuyez sur ⌘ / Ctrl↵ pour enregistrer.
- Sélectionnez la section 3.2 Interface Matrix et lisez la matrice d'interfaces dynamique que le modèle y a placée.
- Pour un parcours guidé et contrôlé, lancez le tutoriel 11 Produce the Deliverable (Aide → Tutoriels).
C'est terminé quand le nouvel ICD montre votre propre texte en 2.3 à la place des consignes, et que 3.2 montre une matrice des composants d'EO-1.
Vérifiez vos connaissances
- Qu'est-ce qui détermine les modèles que Nouveau document propose en premier ?
- Quelle est la différence entre un modèle avec et sans consignes de rédaction ?
- Pourquoi est-il important que chaque section soit un élément du modèle ?
Afficher les réponses
Qu'est-ce qui détermine les modèles que Nouveau document propose en premier ?
Le type de document choisi sous Modèles pour. Les modèles des autres types restent listés sous Autres modèles ; le document prend le type du modèle que vous choisissez.
Quelle est la différence entre un modèle avec et sans consignes de rédaction ?
Les deux donnent les mêmes sections numérotées et les mêmes tableaux de départ. Avec consignes, chaque section commence en plus par un court guide de ce qu'elle doit contenir, que vous remplacez au fil de la rédaction.
Pourquoi est-il important que chaque section soit un élément du modèle ?
Une section est un Statement : vous pouvez la relier, la commenter et la placer dans une référence comme une exigence, et le document reste une vue du modèle.
Pour aller plus loin
Transcription
Afficher la transcription (narration et contenu de l'écran)
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.