Holarch

Requisiti

Generazione di documenti

Inserire nei documenti matrici di tracciabilità, verifica e interfacce e report di test sempre aggiornati, esportarli in quattro formati, generarli da una baseline e contrassegnarli: un avviso aziendale, una distribution statement DoD, un avviso di controllo delle esportazioni, un copyright o un numero di contratto su ogni pagina ed esportazione.

Come usarlo →

In questa pagina
  1. Panoramica
  2. Concetti
    1. Le matrici
    2. Aggiornate, non copiate
  3. Come usarlo
    1. Inserire una matrice in un documento
    2. Esportare una matrice
    3. Matrici da una baseline
    4. Report di test
    5. Contrassegnare documenti ed esportazioni
    6. Impostare la marcatura del progetto
    7. Impostare la marcatura dell'organizzazione
    8. Assegnare a un documento la propria marcatura, una copertina e i numeri di pagina
    9. Dove vengono stampate le marcature
  4. Controlli del modello
  5. Suggerimenti

Panoramica

Holarch genera i deliverable dal modello, quindi un documento corrisponde sempre ai requisiti, ai test e ai collegamenti che lo sostengono. Tre strumenti coprono ciò che i revisori chiedono di solito:

  • Blocchi matrice: una matrice di tracciabilità, di verifica o delle interfacce, o un report di test, all'interno del testo di un documento, che si aggiorna ogni volta che il modello cambia.
  • Esporta matrice: le stesse matrici e il Test Report come file a sé in Excel, Word, CSV o pagina web, dal modello corrente o da una baseline.
  • Marcature e Imposta pagina: una marcatura per l'organizzazione, il progetto o un documento (un avviso aziendale, una distribution statement, un avviso di controllo delle esportazioni, un copyright o un numero di contratto) su ogni esportazione, più una copertina e i numeri di pagina per Word.

I valori e le tabelle dinamici nel testo sono trattati nella pagina Documenti: Valore dinamico… inserisce un attributo di un'entità, Conteggio o totale… un numero calcolato da una query, Tabella dinamica… una tabella da una query, e Riferimento incrociato… il numero corrente di una sezione, figura o tabella.

Concetti

Le matrici

MatriceRigheColonneEvidenziato come lacuna
RTM (Requirements Traceability Matrix)RequisitiNumber, Requirement, Parent, Traced From, Traced To, Satisfied ByUn requisito senza padre e senza nulla da cui sia tracciato
Matrice di derivazione dei requisitiRequisitiNumber, Requirement, Flows Down From, Flows Down To, Derived RequirementsUn requisito di primo livello senza figli e senza requisiti derivati
Matrice di allocazione dei requisitiRequisitiNumber, Requirement, Components, Functions, OtherUn requisito che nulla soddisfa
Matrice di conformità (mostrata quando il programma formale è attivo)Requisiti di una specifica del clienteNumber, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/WaiverUn requisito senza dichiarazione di conformità (Non valutato)
RVTM (Requirements Verification Traceability Matrix)RequisitiNumber, Requirement, Method, Level, Verified By, StatusNessun metodo di verifica o nessun caso di test che lo verifichi
VCRM (Verification Cross-Reference Matrix)RequisitiNumber, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, StatusNessun metodo di verifica scelto
VCRM per livello di verificaRequisitiNumber, Requirement, poi I, A, D e T sotto ogni livello di verifica, Verified By, StatusNessun metodo di verifica o nessun livello di verifica
Test ReportCasi di test di un ciclo di testNumber, Test Case, Verifies, Status, Actual Result, RunUn caso di test che non è stato superato nel ciclo
Matrice di allocazioneFunzioni (Action)Number, Function, Performed ByUna funzione che nessun componente esegue
Matrice delle interfacceComponenti (Asset)Gli stessi componenti; una cella elenca i Conduit dal componente della riga al componente della colonnaUn componente senza Conduit verso o dagli altri
Matrice N²Funzioni (Action)Le stesse funzioni; una cella elenca gli Input/Output che la funzione della riga genera e la funzione della colonna riceveUna funzione che non scambia input né output
Matrice personalizzataEntità da una query di ricercaEntità da una seconda query; una cella nomina le relazioni tra le due, o mostra X per una relazione sceltaUna riga senza relazioni con alcuna colonna
  • Parent è il requisito che la riga decomposes. Traced From, Traced To e Satisfied By elencano le entità correlate. Nella matrice di derivazione, i Derived Requirements sono i requisiti a cui la riga traces to.
  • Nella VCRM una X indica ogni metodo pianificato; Status è il risultato della verifica finora, aggregato dai casi di test come nel Centro test.
  • Nella VCRM per livello di verifica, le colonne sono raggruppate per i livelli dell'attributo Verification Level (Component, Subsystem, System). Una X sta sotto il livello del requisito e ciascuno dei suoi metodi pianificati.
  • I casi di test non vengono mai elencati come funzioni: le matrici di allocazione e N² mostrano le Action che non sono Test Case.
  • Ambito: una matrice copre le entità di un documento (nell'ordine e nella numerazione del documento), tutte le parti di una raccolta, o l'intero progetto. La matrice di allocazione usa le funzioni del documento, o tutte le funzioni quando il documento non ne ha. Le matrici delle interfacce e N² possono anche coprire i figli di un Asset o di una Action, come fanno i diagrammi I² e N²; per l'intero progetto elencano i componenti o le funzioni che hanno un Conduit o un Input/Output, fino a 120. La matrice personalizzata mostra fino a 2.000 righe e 120 colonne.
  • Il blocco Test Report mostra un ciclo di test di una suite di test, o i suoi risultati attuali. Vedere Report di test.

Aggiornate, non copiate

Un blocco matrice memorizza solo che cosa mostrare, non le righe. Ogni volta che il documento viene visualizzato o esportato, Holarch ricostruisce le righe dal modello. Il risultato resta in cache fino alla modifica successiva, così i progetti grandi restano veloci.

Come usarlo

Inserire una matrice in un documento

  1. Aprire il documento e fare clic nella descrizione del documento o di un elemento.
  2. Nella barra degli strumenti del testo formattato, aprire + e scegliere Matrice….
  3. Scegliere la Matrice e l'Ambito. L'ambito parte dal documento aperto.
    • Per una Matrice personalizzata, inserire le query di ricerca Righe e Colonne (per esempio class:Requirement e class:Asset), scegliere una Relazione o mantenere Qualsiasi relazione, e assegnarle facoltativamente un Titolo.
    • Per un Test Report, scegliere la Suite di test e il Ciclo di test, o Risultati attuali.

      Compare un'anteprima. Si aggiorna ogni volta che il modello cambia.

  4. Fare clic su Inserisci.

    La matrice compare nel testo con un contorno tratteggiato. La sua didascalia nomina la matrice, l'ambito e quante righe hanno lacune.

La matrice non può essere modificata cella per cella; modificare invece il modello. Per rimuoverla, eliminare la tabella nell'editor come qualsiasi altro contenuto.

Esportare una matrice

  1. In un documento, aprire Consegna ▾ e scegliere Matrice di tracciabilità…. Oppure scegliere Consegna ▾ → Tutte le esportazioni… e selezionare Matrice di tracciabilità (Excel), (Word), (CSV) o (HTML).
  2. In Esporta matrice, scegliere la Matrice e l'Ambito, e in Esporta come scegliere Matrice (Excel), Matrice (Word), Matrice (CSV) o Matrice (HTML).
  3. Facoltativo: in Modello, scegliere una baseline invece di Modello corrente. L'elenco mostra le baseline del progetto e quelle del documento scelto.

    La riga sotto i campi indica il numero di righe e il numero di righe con lacune.

  4. Fare clic su Esporta.

    Il messaggio riporta “Matrice esportata.” Le lacune sono ombreggiate in rosso in Excel, Word e nella pagina web. Le esportazioni Word e pagina web usano l'Imposta pagina del documento. In Word, le colonne di testo sono larghe e le colonne dei metodi di verifica sono strette, con intestazione I, A, D e T e una legenda sotto la tabella (I = Inspection, A = Analysis, D = Demonstration, T = Test). Le matrici con più di cinque colonne usano una pagina orizzontale. La VCRM per livello ha una seconda riga di intestazione con i livelli; le matrici delle interfacce, N² e personalizzate ombreggiano le intestazioni di riga e la diagonale.

Matrici da una baseline

Un deliverable firmato deve mostrare il modello com'era al momento della baseline, non com'è oggi. Una matrice generata da una baseline usa le entità e le relazioni della baseline, e il suo titolo termina con “(baseline nome)”.

  • Esporta matrice: scegliere la baseline in Modello.
  • Una baseline del progetto contiene l'intero modello, quindi ogni matrice funziona a partire da essa.
  • Una baseline del documento contiene il documento, i suoi elementi e le entità collegate a essi. Le matrici di quel documento sono complete. Una matrice che va oltre il documento (l'intero progetto, o una matrice delle interfacce o N²) riporta la nota “Generata da una baseline del documento, che contiene solo quel documento e le entità collegate a esso.”

Report di test

Un report di test fornisce i risultati di un ciclo di test: che cosa è stato testato, su quale configurazione, che cosa è stato superato e che cosa è fallito, e quali requisiti ciò verifica.

  1. Nel Centro test, registrare un ciclo di test con Avvia nuovo ciclo…. Inserire Configurazione / build e Articolo di test (entrambi partono dai valori registrati più spesso nell'esecuzione).
  2. Nella scheda della suite, aprire ⋯ e scegliere Rapporto di test…. Oppure aprire ⋯ → Cicli di test… e fare clic su Report… su un ciclo.
  3. In Esporta report di test, scegliere il Ciclo di test e, in Esporta come, Report di test (Word), (Excel), (CSV) o (HTML), poi fare clic su Esporta.

Il report Word (predefinito) ha queste sezioni:

  1. Identificazione: suite di test, ciclo di test, quando sono stati salvati i risultati e quando è stato creato il report.
  2. Ambiente e configurazione di test: configurazione o build, articolo di test, tester e date di esecuzione.
  3. Riepilogo dei risultati: conteggi per stato e percentuale di superamento.
  4. Risultati per caso di test: una riga per caso di test.
  5. Risultati dettagliati: per ogni caso di test il risultato atteso ed effettivo, tester, data, configurazione, articolo di test, file di evidenza e i risultati dei passi.
  6. Deviazioni e problemi aperti: i casi di test falliti e bloccati con le loro Issue collegate.
  7. Evidenze di test: i file di evidenza registrati nel ciclo.
  8. Stato di verifica dei requisiti: i requisiti che la suite verifica, con il loro stato dai risultati di questo ciclo.

Excel fornisce tre fogli (Results, Steps, Requirements); CSV e la pagina web forniscono la tabella dei risultati. I risultati provengono dal ciclo così come è stato salvato, quindi il report resta uguale dopo il ripristino della suite. Nomi, requisiti verificati e Issue provengono dal modello corrente. I cicli salvati prima che venissero conservati i risultati dei passi e le evidenze mostrano quei campi come “—”.

Per inserire la tabella dei risultati in un documento, inserire un blocco matrice Test Report (vedere sopra).

Contrassegnare documenti ed esportazioni

Una marcatura è un testo che Holarch stampa su tutto ciò che si esporta: un'intestazione in cima a ogni pagina, un piè di pagina in fondo a ogni pagina e un avviso sulla prima pagina. Impostarla una volta per il progetto, o per l'organizzazione, e ogni esportazione la riporta. Un documento può sostituirla con la propria.

Nota: il servizio ospitato (app.holarch.app) non può contenere informazioni CUI, classificate o soggette a controllo delle esportazioni (Condizioni d'uso). Lì l'elenco standard esclude le Distribution Statement da B a F e l'avviso di controllo delle esportazioni, e una marcatura che nomina CUI, un livello di classificazione (come SECRET//NOFORN), ITAR, EAR o il controllo delle esportazioni, o le Distribution Statement da B a F non viene salvata: “Il servizio ospitato di Holarch non può contenere informazioni CUI, classificate o soggette a controllo delle esportazioni, quindi questa marcatura non può essere usata qui. Rimuoverla, oppure usare l'app desktop o un'installazione self-hosted.” Gli avvisi aziendali come Company Confidential, Distribution Statement A, copyright e numeri di contratto restano disponibili. Le marcature impostate prima di questa regola vengono conservate e vengono ancora stampate; per modificarne una, rimuovere la parte soggetta a restrizioni.

L'app desktop e le installazioni self-hosted offrono l'elenco completo e accettano qualsiasi marcatura. Le marcature sono testo scelto dall'utente; Holarch le stampa ma non applica regole di gestione, e valgono i controlli propri dell'organizzazione. In ogni edizione un avviso di controllo delle esportazioni in una marcatura disattiva l'IA per il progetto.

L'elenco Marcatura standard compila il testo automaticamente:

Marcatura standardIntestazionePiè di paginaAvviso
Proprietà aziendaleCOMPANY PROPRIETARYCOMPANY PROPRIETARYUn avviso di proprietà che nomina l'Azienda
Riservato aziendaleCOMPANY CONFIDENTIALCOMPANY CONFIDENTIALUn avviso di riservatezza che nomina l'Azienda
Da Distribution Statement A a F (da B a F: solo app desktop e self-hosted)(nessuno)DISTRIBUTION STATEMENT A to FIl testo DoD standard della dichiarazione (DoDI 5230.24), con Motivo, Data di determinazione e Ufficio di controllo compilati
Avviso di controllo delle esportazioni (ITAR/EAR) (solo app desktop e self-hosted)(nessuno)Export-controlled technical data. See the notice on the first page.Un avvertimento che il documento può contenere dati tecnici soggetti a ITAR (22 CFR 120–130) o EAR (15 CFR 730–774)
Copyright(nessuno)© Anno Titolare del copyright. All rights reserved.(nessuno)
Numero di contratto(nessuno)Contract No. Numero di contratto(nessuno)

Un campo da compilare lasciato vuoto resta nel testo come segnaposto tra parentesi quadre, come [reason]. L'editor mostra allora “Completare le parti tra parentesi quadre prima di esportare.”

Impostare la marcatura del progetto

  1. Premere ⌘K / Ctrl+K e scegliere Marcatura del progetto…. È possibile aprirla anche da Imposta pagina… in un documento, o da Preferenze del progetto… (Home ▾ in Home) del progetto aperto.
  2. Scegliere Marcatura propria.
  3. In Marcatura standard, scegliere una voce, compilarne i campi (per esempio Azienda) e fare clic su Aggiungi alla marcatura.

    Compaiono Intestazione, Piè di pagina e Avviso compilati. Aggiungere un'altra voce per combinarle: intestazioni e piè di pagina vengono uniti con “ · ”, e ogni avviso diventa un paragrafo a sé.

  4. Modificare il testo se necessario, poi fare clic su Salva.

    Il messaggio riporta “Marcatura del progetto salvata.” Solo i proprietari del progetto modificano la marcatura del progetto; gli altri membri la vedono in sola lettura.

Cancella svuota i tre campi. Nessuna marcatura disattiva la marcatura per il progetto, anche quando l'organizzazione ne ha una.

Impostare la marcatura dell'organizzazione

  1. Aprire il menu dell'account e scegliere Impostazioni organizzazione, poi aprire l'organizzazione.
  2. In Marcatura del documento, fare clic su Modifica marcatura….
  3. Impostare la marcatura come per un progetto e fare clic su Salva.

    Il messaggio riporta “Marcatura dell'organizzazione salvata.” Si applica a ogni progetto dell'organizzazione che non ha una marcatura propria. Solo gli amministratori dell'organizzazione la modificano.

Assegnare a un documento la propria marcatura, una copertina e i numeri di pagina

  1. In un documento, aprire Consegna ▾ e scegliere Imposta pagina….
  2. In Marcatura, scegliere una delle opzioni:
    • Marcatura del progetto o dell'organizzazione (predefinita): la riga sotto nomina la marcatura usata dal documento.
    • Marcatura propria: impostare intestazione, piè di pagina e avviso come per un progetto.
    • Nessuna marcatura: il documento e le sue esportazioni non ne riportano alcuna.
  3. Compilare il resto:
    • Copertina, con Versione e Redatto da. La copertina mostra anche l'avviso.
    • Numeri di pagina (“Pagina X di Y”) nelle esportazioni Word.
  4. Fare clic su Applica.

    Il messaggio riporta “Impostazione della pagina salvata.” L'intestazione e il piè di pagina compaiono in cima e in fondo al documento, e l'avviso sotto il titolo. ⌘Z / Ctrl+Z annulla la modifica in un solo passaggio.

Vince la marcatura più vicina: quella propria del documento, altrimenti quella del progetto, altrimenti quella dell'organizzazione.

Dove vengono stampate le marcature

  • Vista documento e Stampa o PDF…: l'intestazione e il piè di pagina in cima e in fondo a ogni pagina, l'avviso sotto il titolo.
  • L'esportazione Word (Consegna ▾ → {template} (Word), o Documento (Word) in Tutte le esportazioni…): l'intestazione e il piè di pagina si ripetono su ogni pagina, con i numeri di pagina se scelti, e la copertina sostituisce il titolo semplice. Un blocco matrice dinamico nel documento diventa una tabella Word con il titolo sopra, le stesse larghezze di colonna e intestazioni I/A/D/T, e le lacune ombreggiate in rosso.
  • Esporta matrice e Matrice di tracciabilità (Word) o (HTML).
  • Altri file Word: il documento ICD, la presentazione, il diagramma e le esportazioni Scomposizione (Word) riportano l'intestazione e il piè di pagina su ogni pagina e l'avviso sotto il titolo.
  • Report Excel: l'intestazione e il piè di pagina vanno nell'intestazione e nel piè di pagina di ogni foglio, che Excel mostra nella visualizzazione Layout di pagina e stampa.
  • CSV: solo quando si seleziona Marcatura come prima riga in Tabella (CSV). È disattivato per impostazione predefinita, così il file si reimporta così com'è.
  • Immagini dei diagrammi: le esportazioni PNG e SVG ricevono una fascia sopra il diagramma con l'intestazione e una fascia sotto con il piè di pagina e l'avviso. Le esportazioni Pagina web (HTML) li mostrano in cima e in fondo alla pagina. Le miniature e le immagini dei diagrammi all'interno dei documenti restano senza marcatura.
  • Presentazioni: le diapositive PowerPoint, pagina web, PNG e SVG mostrano l'intestazione e il piè di pagina su ogni diapositiva e l'avviso sulla prima diapositiva.
  • Una raccolta ha il proprio Imposta pagina, usato quando si esporta la raccolta.

Controlli del modello

I Controlli del modello segnalano un valore dinamico o una tabella dinamica che punta a qualcosa di eliminato (regola Global.7, “Valori dinamici che puntano a destinazioni mancanti”):

  • Un Valore dinamico la cui entità è stata eliminata mostra “{Entity: … Not found}”.
  • Un blocco matrice il cui documento di ambito è stato eliminato, un blocco Test Report la cui suite di test o il cui ciclo di test è stato eliminato, o una Matrice personalizzata la cui relazione non esiste più.
  • Un Conteggio o totale o una Tabella dinamica la cui query nomina una classe, un'etichetta, una relazione o un documento che non esiste.
  • Un Riferimento incrociato il cui elemento, figura o tabella è stato eliminato.

Aprire la descrizione, poi modificare o rimuovere il valore dinamico, o inserirlo di nuovo per una destinazione esistente. Vedere Controlli del modello.

Suggerimenti

  • Mettere la RVTM o la VCRM alla fine di una specifica come sezione di verifica; resta aggiornata fino alla revisione.
  • Per un pacchetto di revisione, creare una raccolta e assegnarle una copertina e una marcatura nel suo Imposta pagina.
  • Esportare la VCRM in Excel per un comitato di revisione che la annota, e mantenere il blocco dinamico nel documento.
  • Per un piano di verifica organizzato per livello di integrazione, usare la VCRM per livello di verifica e impostare prima il Livello di verifica di ogni requisito.
  • Per un documento di controllo delle interfacce, inserire una Matrice delle interfacce con ambito sull'Asset di sistema, così i suoi figli e i loro Conduit compaiono sulla diagonale e nelle celle.