Holarch
Chapitres du cours

Formation · Parcours 1. Prise en main · Chapitre 1.5 sur 8

1.5 Documents 2:46

Rédiger une spécification dont les exigences sont des éléments du modèle.

Montre Holarch 1.27.

Ce que vous allez apprendre

  • Créer une spécification d'exigences à partir d'un modèle intégré
  • Ajouter une exigence sous une section et rédiger son énoncé « shall »
  • Ajouter rapidement plusieurs exigences avec Ajout rapide
  • Retrouver les exigences d'un document dans la Base de données en tant qu'éléments du modèle
  • Exporter la spécification vers Word depuis le menu Livrer

Créez la spécification des exigences système du Bike-Share Dock à partir d'un modèle intégré, rédigez une exigence sous une section avec + Enfant et l'inspecteur, ajoutez-en d'autres avec Ajout rapide, constatez que chaque exigence du document est un élément du modèle dans la Base de données, et exportez le document vers Word.

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.

  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)).
  2. Ouvrez Besoins et exigences → Documents et cliquez sur + Nouveau document. Nommez-le EO-1 Ground Station Specification, choisissez le modèle Requirements Specification et cliquez sur Créer.
  3. Sélectionnez la section 4.1 Primary Functions, cliquez sur + Enfant, nommez l'exigence Track the Spacecraft et rédigez son énoncé « shall » dans la description de l'inspecteur.
  4. Dans Ajout rapide en bas, choisissez Sous 10 Design Constraints, saisissez The ground station antenna shall have a diameter of no more than 3.7 m. et appuyez sur Entrée. Ajoutez une seconde contrainte de la même manière.
  5. Ouvrez la Base de données et saisissez in:"EO-1 Ground Station Specification" class:Requirement dans le champ de recherche pour lister les nouvelles exigences.
  6. De retour dans le document, choisissez Livrer ▾ → Spécification (Word) et ouvrez le fichier.

C'est terminé quand le fichier Word montre vos trois exigences sous leurs sections numérotées.

Vérifiez vos connaissances

  1. Quelle est la différence entre une exigence saisie dans un document Holarch et une exigence saisie dans un traitement de texte ?
  2. Comment Ajout rapide choisit-il le nom de la nouvelle exigence ?
  3. Quand cocher Inclure les consignes de rédaction ?
Afficher les réponses
  1. Quelle est la différence entre une exigence saisie dans un document Holarch et une exigence saisie dans un traitement de texte ?

    Dans Holarch, chaque exigence du document est un élément du modèle : vous pouvez la tracer, contrôler sa qualité, la dessiner sur des diagrammes et la retrouver dans la Base de données.

  2. Comment Ajout rapide choisit-il le nom de la nouvelle exigence ?

    Il nomme l'exigence d'après les mots qui suivent shall et la numérote après ses sœurs dans la section choisie.

  3. Quand cocher Inclure les consignes de rédaction ?

    Quand les auteurs découvrent le type de document : chaque section reçoit alors une courte note sur ce qu'elle doit contenir, que vous supprimez au fil de la rédaction.

Pour aller plus loin

Transcription

Afficher la transcription (narration et contenu de l'écran)

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.