Exigences
Génération de documents
Placez dans les documents des matrices de traçabilité, de vérification et d'interfaces et des rapports de test tenus à jour, exportez-les dans quatre formats, construisez-les à partir d'une référence et apposez-leur des marquages : une mention d'entreprise, une mention de diffusion du DoD, une mention de contrôle des exportations, un copyright ou un numéro de contrat sur chaque page et chaque export.
Sur cette page
- Vue d'ensemble
- Concepts
- Mode d'emploi
- Insérer une matrice dans un document
- Exporter une matrice
- Matrices à partir d'une référence
- Rapports de test
- Marquer les documents et les exports
- Définir le marquage du projet
- Définir le marquage de l'organisation
- Donner à un document son propre marquage, une page de garde et des numéros de page
- Où s'impriment les marquages
- Contrôles du modèle
- Conseils
Vue d'ensemble
Holarch construit les livrables à partir du modèle : un document correspond donc toujours aux exigences, aux tests et aux liens qui le sous-tendent. Trois outils couvrent ce que les relecteurs demandent habituellement :
- Blocs matrice : une matrice de traçabilité, de vérification ou d'interfaces, ou un rapport de test, dans le texte d'un document, mis à jour chaque fois que le modèle change.
- Exporter la matrice : les mêmes matrices et le rapport de test dans leur propre fichier Excel, Word, CSV ou page web, à partir du modèle actuel ou d'une référence.
- Marquages et mise en page : un marquage pour l'organisation, le projet ou un document (une mention d'entreprise, une mention de diffusion, une mention de contrôle des exportations, un copyright ou un numéro de contrat) sur chaque export, plus une page de garde et des numéros de page pour Word.
Les valeurs et tableaux dynamiques dans le texte sont traités sur la page Documents : Valeur dynamique… insère un attribut d'une entité, Nombre ou total… un nombre calculé à partir d'une requête, Tableau dynamique… un tableau issu d'une requête, et Renvoi… le numéro actuel d'une section, d'une figure ou d'un tableau.
Concepts
Les matrices
| Matrice | Lignes | Colonnes | Mis en évidence comme lacune |
|---|---|---|---|
| RTM (matrice de traçabilité des exigences) | Exigences | Numéro, Exigence, Parent, Traced From, Traced To, Satisfied By | Une exigence sans parent et sans rien dont elle est tracée |
| Matrice de déclinaison des exigences | Exigences | Numéro, Exigence, Déclinée de, Déclinée en, Exigences dérivées | Une exigence de premier niveau sans enfant ni exigence dérivée |
| Matrice d'allocation des exigences | Exigences | Numéro, Exigence, Composants, Fonctions, Autres | Une exigence que rien ne satisfait |
| Matrice de conformité (affichée lorsque le programme formel est activé) | Exigences d'une spécification client | Numéro, Exigence, Conformité, Réponse, Nos exigences et notre conception, Vérification, Dérogation/acceptation | Une exigence sans déclaration de conformité (Non évaluée) |
| RVTM (matrice de traçabilité de la vérification des exigences) | Exigences | Numéro, Exigence, Méthode, Niveau, Verified By, Statut | Aucune méthode de vérification ou aucun cas de test de vérification |
| VCRM (matrice de références croisées de vérification) | Exigences | Numéro, Exigence, Inspection, Analyse, Démonstration, Test, Verified By, Statut | Aucune méthode de vérification choisie |
| VCRM par niveau de vérification | Exigences | Numéro, Exigence, puis I, A, R et T sous chaque niveau de vérification, Verified By, Statut | Aucune méthode de vérification ou aucun niveau de vérification |
| Rapport de test | Cas de test d'un cycle de test | Numéro, Cas de test, Verifies, Statut, Résultat réel, Exécution | Un cas de test qui n'a pas réussi dans le cycle |
| Matrice d'allocation | Fonctions (Actions) | Numéro, Fonction, Performed By | Une fonction qu'aucun composant n'exécute |
| Matrice d'interfaces | Composants (Assets) | Les mêmes composants ; une cellule liste les Conduits du composant de la ligne vers le composant de la colonne | Un composant sans Conduit vers ou depuis les autres |
| Matrice N² | Fonctions (Actions) | Les mêmes fonctions ; une cellule liste les Input/Outputs que la fonction de la ligne génère et que la fonction de la colonne reçoit | Une fonction qui n'échange aucune entrée ni sortie |
| Matrice personnalisée | Entités issues d'une requête de recherche | Entités issues d'une seconde requête ; une cellule nomme les relations entre les deux, ou affiche X pour une relation choisie | Une ligne sans relation avec aucune colonne |
- Parent est l'exigence que la ligne decomposes. Traced From, Traced To et Satisfied By listent les entités liées. Dans la matrice de déclinaison, les Exigences dérivées sont les exigences vers lesquelles la ligne traces to.
- Dans la VCRM, un X marque chaque méthode prévue ; Statut est le résultat de vérification à ce jour, agrégé à partir des cas de test comme dans le Centre de test.
- Dans la VCRM par niveau de vérification, les colonnes sont regroupées selon les niveaux de l'attribut Niveau de vérification (Composant, Sous-système, Système). Un X figure sous le niveau de l'exigence et sous chacune de ses méthodes prévues.
- Les cas de test ne sont jamais listés comme fonctions : les matrices d'allocation et N² affichent les Actions qui ne sont pas des Test Cases.
- Portée : une matrice couvre les entités d'un document (dans l'ordre et la numérotation du document), toutes les parties d'une compilation, ou tout le projet. La matrice d'allocation utilise les fonctions du document, ou toutes les fonctions lorsque le document n'en a pas. Les matrices d'interfaces et N² peuvent aussi couvrir les enfants d'un Asset ou d'une Action, comme les diagrammes I² et N² ; pour tout le projet, elles listent les composants ou fonctions qui ont un Conduit ou un Input/Output, jusqu'à 120. La matrice personnalisée affiche jusqu'à 2 000 lignes et 120 colonnes.
- Le bloc Rapport de test affiche un cycle de test d'une suite de tests, ou ses résultats actuels. Voir Rapports de test.
Dynamiques, pas copiées
Un bloc matrice n'enregistre que ce qu'il faut afficher, pas les lignes. Chaque fois que le document est affiché ou exporté, Holarch reconstruit les lignes à partir du modèle. Le résultat est mis en cache jusqu'à la modification suivante, si bien que les grands projets restent rapides.
Mode d'emploi
Insérer une matrice dans un document
- Ouvrez le document et cliquez dans la description du document ou d'un élément.
- Dans la barre d'outils du texte enrichi, ouvrez + et choisissez Matrice….
- Choisissez la Matrice et la Portée. La portée démarre sur le document ouvert.
- Pour une Matrice personnalisée, saisissez les requêtes de recherche Lignes et Colonnes (par exemple
class:Requirementetclass:Asset), choisissez une Relation ou gardez Toute relation, et donnez-lui un Titre si vous le souhaitez. - Pour un Rapport de test, choisissez la Suite de tests et le Cycle de test, ou Résultats actuels.
Un aperçu s'affiche. Il se met à jour chaque fois que le modèle change.
- Pour une Matrice personnalisée, saisissez les requêtes de recherche Lignes et Colonnes (par exemple
- Cliquez sur Insérer.
La matrice apparaît dans le texte avec un contour en pointillés. Sa légende nomme la matrice, la portée et le nombre de lignes présentant des lacunes.
La matrice ne se modifie pas cellule par cellule ; modifiez plutôt le modèle. Pour la retirer, supprimez le tableau dans l'éditeur comme tout autre contenu.
Exporter une matrice
- Dans un document, ouvrez Livrer ▾ et choisissez Matrice de traçabilité…. Ou choisissez Livrer ▾ → Tous les exports… et prenez Matrice de traçabilité (Excel), (Word), (CSV) ou (HTML).
- Dans Exporter la matrice, choisissez la Matrice et la Portée, et dans Exporter en, choisissez Matrice (Excel), Matrice (Word), Matrice (CSV) ou Matrice (HTML).
- Facultatif : dans Modèle, choisissez une référence au lieu de Modèle actuel. La liste affiche les références du projet et celles du document choisi.
La ligne sous les champs donne le nombre de lignes et le nombre de lignes présentant des lacunes.
- Cliquez sur Exporter.
Le message indique « Matrice exportée. » Les lacunes sont ombrées en rouge dans Excel, Word et la page web. Les exports Word et page web utilisent la mise en page du document. Dans Word, les colonnes de texte sont larges et les colonnes de méthode de vérification étroites, intitulées I, A, R et T, avec une légende sous le tableau (I = Inspection, A = Analyse, R = Démonstration, T = Test). Les matrices de plus de cinq colonnes utilisent une page en paysage. La VCRM par niveau a une seconde ligne d'en-tête avec les niveaux ; les matrices d'interfaces, N² et personnalisées ombrent leurs en-têtes de ligne et leur diagonale.
Matrices à partir d'une référence
Un livrable signé doit montrer le modèle tel qu'il a été figé en référence, et non tel qu'il est aujourd'hui. Une matrice construite à partir d'une référence utilise les entités et les relations de la référence, et son titre se termine par « (référence nom) ».
- Exporter la matrice : choisissez la référence dans Modèle.
- Une référence de projet contient tout le modèle : toutes les matrices fonctionnent donc à partir d'elle.
- Une référence de document contient le document, ses éléments et les entités qui leur sont liées. Les matrices de ce document sont complètes. Une matrice qui déborde du document (tout le projet, ou une matrice d'interfaces ou N²) porte la note « Construite à partir d'une référence de document, qui ne contient que ce document et les entités qui lui sont liées. »
Rapports de test
Un rapport de test donne les résultats d'un cycle de test : ce qui a été testé, sur quelle configuration, ce qui a réussi et échoué, et quelles exigences cela vérifie.
- Dans le Centre de test, enregistrez un cycle de test avec Démarrer un nouveau cycle…. Saisissez la Configuration / build et l'Article de test (les deux démarrent avec les valeurs le plus souvent enregistrées dans l'exécution).
- Sur la carte de la suite, ouvrez ⋯ et choisissez Rapport de test…. Ou ouvrez ⋯ → Cycles de test… et cliquez sur Rapport… sur un cycle.
- Dans Exporter le rapport de test, choisissez le Cycle de test et, dans Exporter en, Rapport de test (Word), (Excel), (CSV) ou (HTML), puis cliquez sur Exporter.
Le rapport Word (par défaut) comporte ces sections :
- Identification : suite de tests, cycle de test, date d'enregistrement des résultats et date de création du rapport.
- Environnement et configuration de test : configuration ou build, article de test, testeurs et dates d'exécution.
- Synthèse des résultats : nombres par statut et taux de réussite.
- Résultats par cas de test : une ligne par cas de test.
- Résultats détaillés : pour chaque cas de test, le résultat attendu et le résultat réel, le testeur, la date, la configuration, l'article de test, le fichier de preuve et les résultats des étapes.
- Écarts et problèmes ouverts : les cas de test en échec et bloqués avec leurs Issues liées.
- Preuves de test : les fichiers de preuve enregistrés dans le cycle.
- État de vérification des exigences : les exigences que la suite vérifie, avec leur statut d'après les résultats de ce cycle.
Excel fournit trois feuilles (Results, Steps, Requirements) ; CSV et la page web fournissent le tableau des résultats. Les résultats proviennent du cycle tel qu'il a été enregistré : le rapport reste donc le même après la réinitialisation de la suite. Les noms, les exigences vérifiées et les Issues proviennent du modèle actuel. Les cycles enregistrés avant la conservation des résultats d'étapes et des preuves affichent ces champs sous la forme « — ».
Pour placer le tableau des résultats dans un document, insérez un bloc matrice Rapport de test (voir ci-dessus).
Marquer les documents et les exports
Un marquage est un texte que Holarch imprime sur tout ce que vous exportez : un en-tête en haut de chaque page, un pied de page en bas de chaque page et une mention sur la première page. Définissez-le une fois pour le projet, ou pour l'organisation, et chaque export le porte. Un document peut le remplacer par le sien.
Note : le service hébergé (app.holarch.app) ne peut pas contenir d'informations CUI, classifiées ou soumises au contrôle des exportations (Conditions d'utilisation). La liste standard y exclut les Distribution Statements B à F et la mention de contrôle des exportations, et un marquage qui nomme CUI, un niveau de classification (comme SECRET//NOFORN), ITAR, EAR ou le contrôle des exportations, ou les Distribution Statements B à F n'est pas enregistré : « Le service hébergé de Holarch ne peut pas contenir d'informations CUI, classifiées ou soumises au contrôle des exportations : ce marquage ne peut donc pas être utilisé ici. Retirez-le, ou utilisez l'application de bureau ou une installation auto-hébergée. » Les mentions d'entreprise comme Confidentiel entreprise, Distribution Statement A, le copyright et les numéros de contrat restent disponibles. Les marquages définis avant cette règle sont conservés et s'impriment toujours ; pour en modifier un, retirez la partie soumise à restriction.
L'application de bureau et les installations auto-hébergées proposent la liste complète et acceptent n'importe quel marquage. Les marquages sont un texte que vous choisissez ; Holarch les imprime mais n'impose pas de règles de traitement, et les contrôles propres à votre organisation s'appliquent. Dans toutes les éditions, une mention de contrôle des exportations dans un marquage désactive l'IA pour le projet.
La liste Marquage standard remplit le texte pour vous :
| Marquage standard | En-tête | Pied de page | Mention |
|---|---|---|---|
| Propriété de l'entreprise | COMPANY PROPRIETARY | COMPANY PROPRIETARY | Une mention de propriété qui nomme l'Entreprise |
| Confidentiel entreprise | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | Une mention de confidentialité qui nomme l'Entreprise |
| Distribution Statement A à F (B à F : application de bureau et auto-hébergé uniquement) | (aucun) | DISTRIBUTION STATEMENT A à F | La formulation standard du DoD pour cette mention (DoDI 5230.24), avec le Motif, la Date de détermination et le Service de contrôle renseignés |
| Mention de contrôle des exportations (ITAR/EAR) (application de bureau et auto-hébergé uniquement) | (aucun) | Export-controlled technical data. See the notice on the first page. | Un avertissement indiquant que le document peut contenir des données techniques relevant de l'ITAR (22 CFR 120–130) ou de l'EAR (15 CFR 730–774) |
| Copyright | (aucun) | © Année Titulaire du copyright. All rights reserved. | (aucun) |
| Numéro de contrat | (aucun) | Contract No. Numéro de contrat | (aucun) |
Un champ à remplir laissé vide reste dans le texte sous forme d'espace réservé entre crochets, comme [reason]. L'éditeur affiche alors « Complétez les parties entre crochets avant d'exporter. »
Définir le marquage du projet
- Appuyez sur ⌘K / Ctrl+K et choisissez Marquage du projet…. Vous pouvez aussi l'ouvrir depuis Mise en page… dans un document, ou depuis Préférences du projet… (Accueil ▾ sur l'Accueil) du projet ouvert.
- Choisissez Marquage propre.
- Dans Marquage standard, choisissez une entrée, renseignez ses champs (par exemple Entreprise) et cliquez sur Ajouter au marquage.
L'En-tête, le Pied de page et la Mention sont remplis. Ajoutez une autre entrée pour les combiner : les en-têtes et pieds de page sont joints par « · », et chaque mention devient son propre paragraphe.
- Modifiez le texte si nécessaire, puis cliquez sur Enregistrer.
Le message indique « Marquage du projet enregistré. » Seuls les propriétaires du projet modifient le marquage du projet ; les autres membres le voient en lecture seule.
Effacer vide les trois champs. Aucun marquage désactive le marquage pour le projet, même lorsque l'organisation en a un.
Définir le marquage de l'organisation
- Ouvrez le menu du compte et choisissez Paramètres de l'organisation, puis ouvrez l'organisation.
- Sous Marquage du document, cliquez sur Modifier le marquage….
- Définissez le marquage comme pour un projet et cliquez sur Enregistrer.
Le message indique « Marquage de l'organisation enregistré. » Il s'applique à chaque projet de l'organisation qui n'a pas de marquage propre. Seuls les administrateurs de l'organisation le modifient.
Donner à un document son propre marquage, une page de garde et des numéros de page
- Dans un document, ouvrez Livrer ▾ et choisissez Mise en page….
- Sous Marquage, choisissez l'une des options :
- Marquage du projet ou de l'organisation (par défaut) : la ligne en dessous nomme le marquage qu'utilise le document.
- Marquage propre : définissez l'en-tête, le pied de page et la mention comme pour un projet.
- Aucun marquage : le document et ses exports n'en portent aucun.
- Renseignez le reste :
- Page de garde, avec Version et Préparé par. La page de garde affiche aussi la mention.
- Numéros de page (« Page X sur Y ») dans les exports Word.
- Cliquez sur Appliquer.
Le message indique « Mise en page enregistrée. » L'en-tête et le pied de page apparaissent en haut et en bas du document, et la mention sous son titre. ⌘Z / Ctrl+Z annule la modification en une étape.
Le marquage le plus proche l'emporte : celui du document, sinon celui du projet, sinon celui de l'organisation.
Où s'impriment les marquages
- Vue du document et Imprimer ou PDF… : l'en-tête et le pied de page en haut et en bas de chaque page, la mention sous le titre.
- L'export Word (Livrer ▾ → {template} (Word), ou Document (Word) dans Tous les exports…) : l'en-tête et le pied de page se répètent sur chaque page, avec les numéros de page s'ils sont choisis, et la page de garde remplace le simple titre. Un bloc matrice dynamique du document devient un tableau Word avec son titre au-dessus, les mêmes largeurs de colonnes et les en-têtes I/A/R/T, et ses lacunes ombrées en rouge.
- Exporter la matrice et Matrice de traçabilité (Word) ou (HTML).
- Autres fichiers Word : le document ICD, la présentation, le diagramme et les exports Décomposition (Word) portent l'en-tête et le pied de page sur chaque page et la mention sous le titre.
- Rapports Excel : l'en-tête et le pied de page vont dans l'en-tête et le pied de page de chaque feuille, qu'Excel affiche en mode Mise en page et imprime.
- CSV : seulement si vous cochez Marquage en première ligne dans Tableau (CSV). L'option est désactivée par défaut, pour que le fichier puisse être réimporté tel quel.
- Images de diagramme : les exports PNG et SVG reçoivent une bande au-dessus du diagramme avec l'en-tête et une bande en dessous avec le pied de page et la mention. Les exports Page web (HTML) les affichent en haut et en bas de la page. Les vignettes et les images de diagramme dans les documents restent sans marquage.
- Présentations : les diapositives PowerPoint, page web, PNG et SVG affichent l'en-tête et le pied de page sur chaque diapositive et la mention sur la première.
- Une compilation a sa propre mise en page, utilisée lorsque vous exportez la compilation.
Contrôles du modèle
Les Contrôles du modèle signalent une valeur dynamique ou un tableau dynamique qui pointe vers quelque chose de supprimé (règle Global.7, « Valeurs dynamiques pointant vers des cibles manquantes ») :
- Une valeur dynamique dont l'entité a été supprimée affiche « {Entité : … introuvable} ».
- Un bloc matrice dont le document de portée a été supprimé, un bloc Rapport de test dont la suite ou le cycle de test a été supprimé, ou une Matrice personnalisée dont la relation n'existe plus.
- Un Nombre ou total ou un Tableau dynamique dont la requête nomme une classe, une étiquette, une relation ou un document qui n'existe pas.
- Un Renvoi dont l'élément, la figure ou le tableau a été supprimé.
Ouvrez la description, puis modifiez ou retirez la valeur dynamique, ou insérez-la de nouveau pour une cible qui existe. Voir Contrôles du modèle.
Conseils
- Placez la RVTM ou la VCRM à la fin d'une spécification comme section de vérification ; elle reste à jour jusqu'à la revue.
- Pour un dossier de revue, construisez une compilation et donnez-lui une page de garde et un marquage dans sa propre mise en page.
- Exportez la VCRM vers Excel pour un comité de revue qui l'annote, et gardez le bloc dynamique dans le document.
- Pour un plan de vérification organisé par niveau d'intégration, utilisez la VCRM par niveau de vérification et définissez d'abord le Niveau de vérification de chaque exigence.
- Pour un document de contrôle d'interface, insérez une Matrice d'interfaces limitée à l'Asset système, pour que ses enfants et leurs Conduits apparaissent sur la diagonale et dans les cellules.