Anforderungen
Dokumenterstellung
Fügen Sie Live-Matrizen für Nachverfolgbarkeit, Verifikation und Schnittstellen sowie Testberichte in Dokumente ein, exportieren Sie sie in vier Formaten, erstellen Sie sie aus einer Baseline und kennzeichnen Sie sie: ein Firmenhinweis, ein DoD-Verteilungsvermerk, ein Exportkontrollhinweis, ein Copyright oder eine Vertragsnummer auf jeder Seite und in jedem Export.
Auf dieser Seite
- Überblick
- Konzepte
- So setzen Sie es ein
- Eine Matrix in ein Dokument einfügen
- Eine Matrix exportieren
- Matrizen aus einer Baseline
- Testberichte
- Dokumente und Exporte kennzeichnen
- Die Projektkennzeichnung festlegen
- Die Organisationskennzeichnung festlegen
- Einem Dokument eine eigene Kennzeichnung, ein Deckblatt und Seitenzahlen geben
- Wo Kennzeichnungen gedruckt werden
- Modellprüfungen
- Tipps
Überblick
Holarch baut Liefergegenstände aus dem Modell, sodass ein Dokument immer zu den Anforderungen, Tests und Verknüpfungen dahinter passt. Drei Werkzeuge decken ab, was Prüfer üblicherweise verlangen:
- Matrixblöcke: eine Nachverfolgbarkeits-, Verifikations- oder Schnittstellenmatrix oder ein Testbericht im Text eines Dokuments, der sich aktualisiert, wann immer sich das Modell ändert.
- Matrix exportieren: dieselben Matrizen und der Test Report als eigene Datei in Excel, Word, CSV oder als Webseite, aus dem aktuellen Modell oder aus einer Baseline.
- Kennzeichnungen und Seite einrichten: eine Kennzeichnung für die Organisation, das Projekt oder ein Dokument (ein Firmenhinweis, ein Verteilungsvermerk, ein Exportkontrollhinweis, ein Copyright oder eine Vertragsnummer) auf jedem Export, dazu ein Deckblatt und Seitenzahlen für Word.
Live-Werte und -Tabellen im Text werden auf der Seite Dokumente behandelt: Live-Wert… fügt ein Attribut einer Entität ein, Anzahl oder Summe… eine aus einer Abfrage berechnete Zahl, Live-Tabelle… eine Tabelle aus einer Abfrage und Querverweis… die aktuelle Nummer eines Abschnitts, einer Abbildung oder einer Tabelle.
Konzepte
Die Matrizen
| Matrix | Zeilen | Spalten | Als Lücke hervorgehoben |
|---|---|---|---|
| RTM (Requirements Traceability Matrix) | Anforderungen | Number, Requirement, Parent, Traced From, Traced To, Satisfied By | Eine Anforderung ohne übergeordnete Anforderung und ohne etwas, von dem sie traced from ist |
| Requirement Flow-Down Matrix | Anforderungen | Number, Requirement, Flows Down From, Flows Down To, Derived Requirements | Eine Anforderung der obersten Ebene ohne untergeordnete und ohne abgeleitete Anforderung |
| Requirement Allocation Matrix | Anforderungen | Number, Requirement, Components, Functions, Other | Eine Anforderung, die nichts erfüllt |
| Konformitätsmatrix (angezeigt, wenn das formale Programm eingeschaltet ist) | Anforderungen einer Kundenspezifikation | Number, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/Waiver | Eine Anforderung ohne Konformitätserklärung (Not assessed) |
| RVTM (Requirements Verification Traceability Matrix) | Anforderungen | Number, Requirement, Method, Level, Verified By, Status | Keine Verifikationsmethode oder kein verifizierender Test Case |
| VCRM (Verification Cross-Reference Matrix) | Anforderungen | Number, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, Status | Keine Verifikationsmethode gewählt |
| VCRM nach Verifikationsstufe | Anforderungen | Number, Requirement, dann I, A, D und T unter jeder Verifikationsstufe, Verified By, Status | Keine Verifikationsmethode oder keine Verifikationsstufe |
| Test Report | Test Cases eines Testzyklus | Number, Test Case, Verifies, Status, Actual Result, Run | Ein Test Case, der im Zyklus nicht bestanden hat |
| Allocation Matrix | Funktionen (Actions) | Number, Function, Performed By | Eine Funktion, die keine Komponente ausführt |
| Interface Matrix | Komponenten (Assets) | Dieselben Komponenten; eine Zelle listet die Conduits von der Zeilenkomponente zur Spaltenkomponente | Eine Komponente ohne Conduit zu oder von den anderen |
| N²-Matrix | Funktionen (Actions) | Dieselben Funktionen; eine Zelle listet die Input/Outputs, die die Zeilenfunktion erzeugt und die Spaltenfunktion empfängt | Eine Funktion, die keinen Input oder Output austauscht |
| Benutzerdefinierte Matrix | Entitäten aus einer Suchabfrage | Entitäten aus einer zweiten Abfrage; eine Zelle nennt die Beziehungen zwischen beiden oder zeigt X für eine gewählte Beziehung | Eine Zeile ohne Beziehung zu irgendeiner Spalte |
- Parent ist die Anforderung, die die Zeile decomposes. Traced From, Traced To und Satisfied By listen die verbundenen Entitäten. In der Flow-Down-Matrix sind Derived Requirements die Anforderungen, zu denen die Zeile traces to.
- In der VCRM markiert ein X jede geplante Methode; Status ist das bisherige Verifikationsergebnis, aus den Test Cases zusammengefasst wie im Test Center.
- In der VCRM nach Verifikationsstufe sind die Spalten nach den Stufen des Attributs Verifikationsstufe gruppiert (Component, Subsystem, System). Ein X steht unter der Stufe der Anforderung und jeder ihrer geplanten Methoden.
- Test Cases werden nie als Funktionen aufgeführt: Die Zuordnungs- und N²-Matrizen zeigen Actions, die keine Test Cases sind.
- Umfang: Eine Matrix deckt die Entitäten eines Dokuments (in Dokumentreihenfolge und -nummerierung), alle Teile einer Zusammenstellung oder das ganze Projekt ab. Die Zuordnungsmatrix verwendet die Funktionen des Dokuments oder alle Funktionen, wenn das Dokument keine hat. Die Schnittstellen- und N²-Matrizen können auch die Unterelemente eines Assets oder einer Action abdecken, wie es die I²- und N²-Diagramme tun; für das ganze Projekt listen sie die Komponenten oder Funktionen mit einem Conduit oder einem Input/Output, bis zu 120. Die benutzerdefinierte Matrix zeigt bis zu 2.000 Zeilen und 120 Spalten.
- Der Block Test Report zeigt einen Testzyklus einer Testsuite oder ihre aktuellen Ergebnisse. Siehe Testberichte.
Live, nicht kopiert
Ein Matrixblock speichert nur, was gezeigt werden soll, nicht die Zeilen. Jedes Mal, wenn das Dokument angezeigt oder exportiert wird, baut Holarch die Zeilen aus dem Modell neu auf. Das Ergebnis wird bis zur nächsten Änderung zwischengespeichert, sodass große Projekte schnell bleiben.
So setzen Sie es ein
Eine Matrix in ein Dokument einfügen
- Öffnen Sie das Dokument und klicken Sie in die Beschreibung des Dokuments oder eines Elements.
- Öffnen Sie in der Rich-Text-Symbolleiste + und wählen Sie Matrix….
- Wählen Sie Matrix und Umfang. Der Umfang beginnt beim geöffneten Dokument.
- Für eine Benutzerdefinierte Matrix geben Sie die Suchabfragen für Zeilen und Spalten ein (zum Beispiel
class:Requirementundclass:Asset), wählen Sie eine Beziehung oder behalten Sie Beliebige Beziehung bei, und geben Sie ihr bei Bedarf einen Titel. - Für einen Test Report wählen Sie die Testsuite und den Testzyklus oder Aktuelle Ergebnisse.
Sie sehen eine Vorschau. Sie aktualisiert sich, wann immer sich das Modell ändert.
- Für eine Benutzerdefinierte Matrix geben Sie die Suchabfragen für Zeilen und Spalten ein (zum Beispiel
- Klicken Sie auf Einfügen.
Die Matrix erscheint im Text mit einem gestrichelten Rahmen. Ihre Beschriftung nennt die Matrix, den Umfang und wie viele Zeilen Lücken haben.
Die Matrix kann nicht Zelle für Zelle bearbeitet werden; ändern Sie stattdessen das Modell. Um sie zu entfernen, löschen Sie die Tabelle im Editor wie jeden anderen Inhalt.
Eine Matrix exportieren
- Öffnen Sie in einem Dokument Liefern ▾ und wählen Sie Nachverfolgbarkeitsmatrix…. Oder wählen Sie Liefern ▾ → Alle Exporte… und dann Traceability matrix (Excel), (Word), (CSV) oder (HTML).
- Wählen Sie unter Matrix exportieren Matrix und Umfang und unter Exportieren als Matrix (Excel), Matrix (Word), Matrix (CSV) oder Matrix (HTML).
- Optional: Wählen Sie unter Modell eine Baseline statt Aktuelles Modell. Die Liste zeigt die Baselines des Projekts und die des gewählten Dokuments.
Die Zeile unter den Feldern nennt die Zeilenanzahl und die Anzahl der Zeilen mit Lücken.
- Klicken Sie auf Exportieren.
Die Meldung lautet "Matrix exportiert." Lücken sind in Excel, Word und der Webseite rot schattiert. Word- und Webseitenexporte verwenden die Seiteneinrichtung des Dokuments. In Word sind die Textspalten breit und die Spalten der Verifikationsmethoden schmal, überschrieben mit I, A, D und T und mit einer Legende unter der Tabelle (I = Inspection, A = Analysis, D = Demonstration, T = Test). Matrizen mit mehr als fünf Spalten verwenden eine Seite im Querformat. Die VCRM nach Stufe hat eine zweite Kopfzeile mit den Stufen; Schnittstellen-, N²- und benutzerdefinierte Matrizen schattieren ihre Zeilenüberschriften und die Diagonale.
Matrizen aus einer Baseline
Ein unterzeichneter Liefergegenstand muss das Modell so zeigen, wie es in der Baseline festgehalten wurde, nicht wie es heute ist. Eine aus einer Baseline gebaute Matrix verwendet die Entitäten und Beziehungen der Baseline, und ihr Titel endet mit "(Baseline Name)".
- Matrix exportieren: Wählen Sie die Baseline unter Modell.
- Eine Projekt-Baseline enthält das ganze Modell, sodass jede Matrix damit funktioniert.
- Eine Dokument-Baseline enthält das Dokument, seine Elemente und die mit ihnen verknüpften Entitäten. Matrizen dieses Dokuments sind vollständig. Eine Matrix, die über das Dokument hinausreicht (das ganze Projekt oder eine Schnittstellen- oder N²-Matrix), trägt die Notiz "Aus einer Dokument-Baseline gebaut, die nur dieses Dokument und die damit verknüpften Entitäten enthält."
Testberichte
Ein Testbericht gibt die Ergebnisse eines Testzyklus wieder: was getestet wurde, mit welcher Konfiguration, was bestanden hat und was fehlgeschlagen ist und welche Anforderungen damit verifiziert werden.
- Halten Sie im Test Center einen Testzyklus mit Neuen Zyklus starten… fest. Geben Sie Konfiguration / Build und Test Article ein (beide beginnen mit den im Lauf am häufigsten festgehaltenen Werten).
- Öffnen Sie auf der Suite-Karte ⋯ und wählen Sie Testbericht…. Oder öffnen Sie ⋯ → Testzyklen… und klicken Sie bei einem Zyklus auf Bericht….
- Wählen Sie unter Testbericht exportieren den Testzyklus und unter Exportieren als Test report (Word), (Excel), (CSV) oder (HTML), und klicken Sie dann auf Exportieren.
Der Word-Bericht (der Standard) hat diese Abschnitte:
- Identification: Testsuite, Testzyklus, wann die Ergebnisse gespeichert und wann der Bericht erstellt wurde.
- Test Environment and Configuration: Konfiguration oder Build, Test Article, Tester und Laufdaten.
- Summary of Results: Anzahlen nach Status und die Bestehensquote.
- Results by Test Case: eine Zeile pro Test Case.
- Detailed Results: pro Test Case das erwartete und tatsächliche Ergebnis, Tester, Datum, Konfiguration, Test Article, Nachweisdatei und die Schrittergebnisse.
- Deviations and Open Issues: fehlgeschlagene und blockierte Test Cases mit ihren verknüpften Issues.
- Test Evidence: die im Zyklus festgehaltenen Nachweisdateien.
- Requirement Verification Status: die Anforderungen, die die Suite verifiziert, mit ihrem Status aus den Ergebnissen dieses Zyklus.
Excel liefert drei Blätter (Results, Steps, Requirements); CSV und die Webseite liefern die Ergebnistabelle. Die Ergebnisse stammen aus dem Zyklus, wie er gespeichert wurde, sodass der Bericht nach dem Zurücksetzen der Suite gleich bleibt. Namen, verifizierte Anforderungen und Issues stammen aus dem aktuellen Modell. Zyklen, die gespeichert wurden, bevor Schrittergebnisse und Nachweise erfasst wurden, zeigen diese Felder als "—".
Um die Ergebnistabelle in ein Dokument zu bringen, fügen Sie einen Matrixblock Test Report ein (siehe oben).
Dokumente und Exporte kennzeichnen
Eine Kennzeichnung ist Text, den Holarch auf alles druckt, was Sie exportieren: eine Kopfzeile oben auf jeder Seite, eine Fußzeile unten auf jeder Seite und einen Hinweis auf der ersten Seite. Legen Sie sie einmal für das Projekt oder für die Organisation fest, und jeder Export trägt sie. Ein Dokument kann sie durch eine eigene ersetzen.
Notiz: Der gehostete Dienst (app.holarch.app) kann keine CUI, keine eingestuften und keine exportkontrollierten Informationen aufnehmen (Nutzungsbedingungen). Dort lässt die Standardliste die Distribution Statements B bis F und den Exportkontrollhinweis weg, und eine Kennzeichnung, die CUI, eine Einstufung (etwa SECRET//NOFORN), ITAR, EAR oder Exportkontrolle oder die Distribution Statements B bis F nennt, wird nicht gespeichert: "Der gehostete Dienst von Holarch kann keine CUI, keine eingestuften und keine exportkontrollierten Informationen aufnehmen, daher kann diese Kennzeichnung hier nicht verwendet werden. Entfernen Sie sie oder verwenden Sie die Desktop-App oder eine selbst gehostete Installation." Firmenhinweise wie Company Confidential, Distribution Statement A, Copyright und Vertragsnummern bleiben verfügbar. Vor dieser Regel festgelegte Kennzeichnungen bleiben erhalten und werden weiter gedruckt; um eine zu ändern, entfernen Sie den eingeschränkten Teil.
Die Desktop-App und selbst gehostete Installationen bieten die ganze Liste und nehmen jede Kennzeichnung an. Kennzeichnungen sind Text, den Sie wählen; Holarch druckt sie, setzt aber keine Handhabungsregeln durch, und es gelten die eigenen Kontrollen Ihrer Organisation. In jeder Edition schaltet ein Exportkontrollhinweis in einer Kennzeichnung KI für das Projekt aus.
Die Liste Standardkennzeichnung füllt den Text für Sie aus:
| Standardkennzeichnung | Kopfzeile | Fußzeile | Hinweis |
|---|---|---|---|
| Firmeneigentum | COMPANY PROPRIETARY | COMPANY PROPRIETARY | Ein Eigentumshinweis, der die Firma nennt |
| Firmenvertraulich | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | Ein Vertraulichkeitshinweis, der die Firma nennt |
| Distribution Statement A bis F (B bis F: nur Desktop-App und selbst gehostet) | (keine) | DISTRIBUTION STATEMENT A to F | Der DoD-Standardwortlaut des Vermerks (DoDI 5230.24), mit ausgefülltem Grund, Datum der Festlegung und Verantwortliche Stelle |
| Exportkontrollhinweis (ITAR/EAR) (nur Desktop-App und selbst gehostet) | (keine) | Export-controlled technical data. See the notice on the first page. | Eine Warnung, dass das Dokument technische Daten unter ITAR (22 CFR 120–130) oder EAR (15 CFR 730–774) enthalten kann |
| Copyright | (keine) | © Jahr Urheberrechtsinhaber. All rights reserved. | (keine) |
| Vertragsnummer | (keine) | Contract No. Vertragsnummer | (keine) |
Ein Feld, das Sie leer lassen, bleibt als Platzhalter in eckigen Klammern im Text, etwa [reason]. Der Editor zeigt dann "Vervollständigen Sie die Teile in eckigen Klammern, bevor Sie exportieren."
Die Projektkennzeichnung festlegen
- Drücken Sie ⌘K / Ctrl+K und wählen Sie Projektkennzeichnung…. Sie können sie auch über Seite einrichten… in einem Dokument öffnen oder über Projekteinstellungen… (Start ▾ auf Start) des geöffneten Projekts.
- Wählen Sie Eigene Kennzeichnung.
- Wählen Sie unter Standardkennzeichnung einen Eintrag, füllen Sie seine Felder aus (zum Beispiel Firma) und klicken Sie auf Zur Kennzeichnung hinzufügen.
Sie sehen Kopfzeile, Fußzeile und Hinweis ausgefüllt. Fügen Sie einen weiteren Eintrag hinzu, um sie zu kombinieren: Kopf- und Fußzeilen werden mit " · " verbunden, und jeder Hinweis wird ein eigener Absatz.
- Bearbeiten Sie den Text bei Bedarf und klicken Sie dann auf Speichern.
Die Meldung lautet "Projektkennzeichnung gespeichert." Nur Projekteigentümer ändern die Projektkennzeichnung; andere Mitglieder sehen sie schreibgeschützt.
Leeren leert die drei Felder. Keine Kennzeichnung schaltet die Kennzeichnung für das Projekt aus, auch wenn die Organisation eine hat.
Die Organisationskennzeichnung festlegen
- Öffnen Sie das Kontomenü, wählen Sie Organisationseinstellungen und öffnen Sie dann die Organisation.
- Klicken Sie unter Dokumentkennzeichnung auf Kennzeichnung bearbeiten….
- Legen Sie die Kennzeichnung wie für ein Projekt fest und klicken Sie auf Speichern.
Die Meldung lautet "Organisationskennzeichnung gespeichert." Sie gilt für jedes Projekt der Organisation, das keine eigene Kennzeichnung hat. Nur Organisationsadministratoren ändern sie.
Einem Dokument eine eigene Kennzeichnung, ein Deckblatt und Seitenzahlen geben
- Öffnen Sie in einem Dokument Liefern ▾ und wählen Sie Seite einrichten….
- Wählen Sie unter Kennzeichnung eines davon:
- Projekt- oder Organisationskennzeichnung (der Standard): Die Zeile darunter nennt die Kennzeichnung, die das Dokument verwendet.
- Eigene Kennzeichnung: Legen Sie Kopfzeile, Fußzeile und Hinweis wie für ein Projekt fest.
- Keine Kennzeichnung: Das Dokument und seine Exporte tragen keine.
- Füllen Sie den Rest aus:
- Deckblatt, mit Version und Erstellt von. Das Deckblatt zeigt auch den Hinweis.
- Seitenzahlen ("Page X of Y") in Word-Exporten.
- Klicken Sie auf Anwenden.
Die Meldung lautet "Seiteneinrichtung gespeichert." Kopf- und Fußzeile erscheinen oben und unten im Dokument, der Hinweis unter seinem Titel. ⌘Z / Ctrl+Z macht die Änderung in einem Schritt rückgängig.
Die nächstliegende Kennzeichnung gilt: die eigene des Dokuments, sonst die des Projekts, sonst die der Organisation.
Wo Kennzeichnungen gedruckt werden
- Dokumentansicht und Drucken oder PDF…: Kopf- und Fußzeile oben und unten auf jeder Seite, der Hinweis unter dem Titel.
- Der Word-Export (Liefern ▾ → {template} (Word) oder Document (Word) in Alle Exporte…): Kopf- und Fußzeile wiederholen sich auf jeder Seite, auf Wunsch mit Seitenzahlen, und das Deckblatt ersetzt den einfachen Titel. Ein Live-Matrixblock im Dokument wird zu einer Word-Tabelle mit ihrem Titel darüber, denselben Spaltenbreiten und I/A/D/T-Kopfzeilen, und seine Lücken sind rot schattiert.
- Matrix exportieren und Nachverfolgbarkeitsmatrix (Word) oder (HTML).
- Andere Word-Dateien: Das ICD-Dokument, die Präsentation, Diagramme und die Exporte Aufschlüsselung (Word) tragen Kopf- und Fußzeile auf jeder Seite und den Hinweis unter dem Titel.
- Excel-Berichte: Kopf- und Fußzeile kommen in die Seitenkopf- und -fußzeile jedes Blatts, die Excel in der Seitenlayoutansicht zeigt und druckt.
- CSV: nur, wenn Sie in Tabelle (CSV) Kennzeichnung als erste Zeile ankreuzen. Die Option ist standardmäßig aus, damit sich die Datei unverändert wieder importieren lässt.
- Diagrammbilder: PNG- und SVG-Exporte erhalten über dem Diagramm ein Band mit der Kopfzeile und darunter ein Band mit der Fußzeile und dem Hinweis. Exporte als Webseite (HTML) zeigen sie oben und unten auf der Seite. Miniaturansichten und Diagrammbilder in Dokumenten bleiben ohne Kennzeichnung.
- Präsentationen: PowerPoint-, Webseiten-, PNG- und SVG-Folien zeigen Kopf- und Fußzeile auf jeder Folie und den Hinweis auf der ersten Folie.
- Eine Zusammenstellung hat ihre eigene Seiteneinrichtung, die beim Export der Zusammenstellung verwendet wird.
Modellprüfungen
Modellprüfungen melden einen Live-Wert oder eine Live-Tabelle, die auf etwas Gelöschtes zeigt (Regel Global.7, "Live-Werte, die auf fehlende Ziele zeigen"):
- Ein Live-Wert, dessen Entität gelöscht wurde, zeigt "{Entity: … Not found}".
- Ein Matrixblock, dessen Umfangsdokument gelöscht wurde, ein Testbericht-Block, dessen Testsuite oder Testzyklus gelöscht wurde, oder eine Benutzerdefinierte Matrix, deren Beziehung nicht mehr existiert.
- Eine Anzahl oder Summe oder Live-Tabelle, deren Abfrage eine Klasse, ein Label, eine Beziehung oder ein Dokument nennt, das nicht existiert.
- Ein Querverweis, dessen Element, Abbildung oder Tabelle gelöscht wurde.
Öffnen Sie die Beschreibung und bearbeiten oder entfernen Sie dann den Live-Wert, oder fügen Sie ihn für ein vorhandenes Ziel neu ein. Siehe Modellprüfungen.
Tipps
- Setzen Sie die RVTM oder VCRM als Verifikationsabschnitt ans Ende einer Spezifikation; sie bleibt bis zur Prüfung aktuell.
- Erstellen Sie für ein Review-Paket eine Zusammenstellung und geben Sie ihr in ihrer eigenen Seiteneinrichtung ein Deckblatt und eine Kennzeichnung.
- Exportieren Sie die VCRM für ein Prüfgremium, das sie mit Anmerkungen versieht, nach Excel, und behalten Sie den Live-Block im Dokument.
- Verwenden Sie für einen nach Integrationsebene gegliederten Verifikationsplan die VCRM nach Verifikationsstufe und legen Sie zuerst die Verifikationsstufe jeder Anforderung fest.
- Fügen Sie für ein Interface Control Document eine Schnittstellenmatrix ein, deren Umfang das System-Asset ist, damit seine Kinder und deren Conduits auf der Diagonale und in den Zellen erscheinen.