要求
ドキュメント生成
ライブのトレーサビリティ、検証、インターフェースのマトリックスとテストレポートをドキュメントに挿入し、4 つの形式でエクスポートし、ベースラインから作成し、区分表示を付けます。会社の告知、DoD 配布ステートメント、輸出管理の告知、著作権表示、契約番号をすべてのページとエクスポートに表示できます。
このページの内容
概要
Holarch はモデルから成果物を作成するため、ドキュメントは常に背後にある要求、テスト、リンクと一致します。レビュー担当者が通常求めるものは、3 つのツールでまかなえます。
- マトリックスブロック:ドキュメントのテキスト内にある、モデルが変わるたびに更新されるトレーサビリティ、検証、インターフェースのマトリックス、またはテストレポート。
- マトリックスのエクスポート:同じマトリックスとテストレポートを、現在のモデルまたはベースラインから、Excel、Word、CSV、Web ページの独立したファイルとして出力します。
- 区分表示とページ設定:組織、プロジェクト、または 1 つのドキュメントの区分表示(会社の通知、配布に関する記述、輸出管理の表示、著作権、契約番号)をすべてのエクスポートに付け、Word では表紙とページ番号も付けます。
テキスト内のライブ値と表については、ドキュメントページで説明しています:ライブ値…はエンティティの 1 つの属性を、件数または合計…はクエリから計算した数値を、ライブテーブル…はクエリによる表を、相互参照…は節、図、表の現在の番号を挿入します。
概念
マトリックス
| マトリックス | 行 | 列 | ギャップとして強調表示されるもの |
|---|---|---|---|
| RTM(要求トレーサビリティマトリックス) | 要求 | Number、Requirement、Parent、Traced From、Traced To、Satisfied By | 親がなく、トレース元もない要求 |
| Requirement Flow-Down Matrix | 要求 | Number、Requirement、Flows Down From、Flows Down To、Derived Requirements | 子も派生要求もない最上位の要求 |
| Requirement Allocation Matrix | 要求 | Number、Requirement、Components、Functions、Other | 何も満たしていない要求 |
| 適合性マトリックス(Formal program がオンの場合に表示) | 顧客の仕様書の要求 | Number、Requirement、Compliance、Response、Our Requirements and Design、Verification、Deviation/Waiver | 適合性の記述がない要求(Not assessed) |
| RVTM(要求検証トレーサビリティマトリックス) | 要求 | Number、Requirement、Method、Level、Verified By、Status | 検証方法がない、または検証するテストケースがない |
| VCRM(検証相互参照マトリックス) | 要求 | Number、Requirement、Inspection、Analysis、Demonstration、Test、Verified By、Status | 検証方法が選ばれていない |
| 検証レベル別 VCRM | 要求 | Number、Requirement、続いて各検証レベルの下に I、A、D、T、Verified By、Status | 検証方法がない、または検証レベルがない |
| Test Report | テストサイクルのテストケース | Number、Test Case、Verifies、Status、Actual Result、Run | サイクルで合格しなかったテストケース |
| Allocation Matrix | 機能(Action) | Number、Function、Performed By | どのコンポーネントも実行しない機能 |
| Interface Matrix | コンポーネント(Asset) | 同じコンポーネント。セルには、行のコンポーネントから列のコンポーネントへの Conduit が一覧表示されます | 他のコンポーネントとの間に Conduit がないコンポーネント |
| N² Matrix | 機能(Action) | 同じ機能。セルには、行の機能が生成し列の機能が受け取る Input/Output が一覧表示されます | 入力も出力もやり取りしない機能 |
| カスタムマトリックス | 検索クエリによるエンティティ | 2 つ目のクエリによるエンティティ。セルには両者の間の関係の名前、または選んだ 1 つの関係について X が表示されます | どの列とも関係がない行 |
- Parent は、その行が decomposes する要求です。Traced From、Traced To、Satisfied By には関連するエンティティが一覧表示されます。フローダウンマトリックスでは、Derived Requirements はその行が traces to する要求です。
- VCRM では、計画された各方法に X が付きます。Status はこれまでの検証結果で、テストセンターと同様にテストケースから集計されます。
- 検証レベル別 VCRMでは、列は検証レベル属性のレベル(Component、Subsystem、System)ごとにまとめられます。X は、要求のレベルと計画された各方法の下に付きます。
- テストケースが機能として一覧表示されることはありません:割り当てマトリックスと N² マトリックスには、Test Case ではない Action が表示されます。
- 範囲:マトリックスは、1 つのドキュメントのエンティティ(ドキュメントの順序と番号付け)、コンパイルのすべてのパート、またはプロジェクト全体を対象にします。割り当てマトリックスは、ドキュメントの機能を、ドキュメントに機能がない場合はすべての機能を使います。インターフェースマトリックスと N² マトリックスは、I² 図や N² 図と同様に、1 つの Asset または Action の子を対象にすることもできます。プロジェクト全体では、Conduit または Input/Output を持つコンポーネントや機能を最大 120 件一覧表示します。カスタムマトリックスは最大 2,000 行、120 列を表示します。
- Test Report ブロックは、1 つのテストスイートの 1 つのテストサイクル、またはその現在の結果を表示します。テストレポートを参照してください。
コピーではなくライブ
マトリックスブロックが保存するのは表示する内容の指定だけで、行は保存しません。ドキュメントを表示またはエクスポートするたびに、モデルから行が作り直されます。結果は次の変更までキャッシュされるため、大きなプロジェクトでも高速です。
使い方
ドキュメントにマトリックスを挿入する
- ドキュメントを開き、ドキュメントまたは項目の説明内をクリックします。
- リッチテキストのツールバーで + を開き、マトリックス…を選択します。
- Matrix と Scope を選びます。範囲は最初は開いているドキュメントです。
- カスタムマトリックスの場合は、行と列の検索クエリ(たとえば
class:Requirementとclass:Asset)を入力し、関係を選ぶか任意の関係のままにし、必要に応じてタイトルを付けます。 - Test Report の場合は、テストスイートとテストサイクル、または現在の結果を選びます。
プレビューが表示されます。モデルが変わるたびに更新されます。
- カスタムマトリックスの場合は、行と列の検索クエリ(たとえば
- 挿入をクリックします。
マトリックスが破線の枠付きでテキストに表示されます。キャプションには、マトリックス、範囲、ギャップのある行数が示されます。
マトリックスはセル単位では編集できません。代わりにモデルを変更します。除去するには、他の内容と同様にエディターで表を削除します。
マトリックスをエクスポートする
- ドキュメントで納品 ▾を開き、トレーサビリティマトリックス…を選択します。または納品 ▾ → すべてのエクスポート…を選び、Traceability matrix (Excel)、(Word)、(CSV)、(HTML) のいずれかを選択します。
- マトリックスをエクスポートで Matrix と Scope を選び、エクスポート形式で Matrix (Excel)、Matrix (Word)、Matrix (CSV)、Matrix (HTML) のいずれかを選択します。
- 任意:モデルで、現在のモデルの代わりにベースラインを選びます。一覧には、プロジェクトのベースラインと選んだドキュメントのベースラインが表示されます。
フィールドの下の行に、行数とギャップのある行数が表示されます。
- エクスポートをクリックします。
トーストに「マトリックスをエクスポートしました。」と表示されます。ギャップは、Excel、Word、Web ページで赤く網掛けされます。Word と Web ページのエクスポートでは、ドキュメントのページ設定が使われます。Word では、テキストの列は広く、検証方法の列は狭く、見出しは I、A、D、T で、表の下に凡例があります(I = Inspection、A = Analysis、D = Demonstration、T = Test)。5 列を超えるマトリックスは横向きのページを使います。レベル別 VCRM にはレベルを示す 2 行目の見出し行があり、インターフェース、N²、カスタムのマトリックスでは行の見出しと対角線が網掛けされます。
ベースラインからのマトリックス
署名済みの成果物には、現在のモデルではなく、ベースライン化した時点のモデルを示す必要があります。ベースラインから作成したマトリックスは、ベースラインのエンティティと関係を使い、タイトルの末尾に「(baseline name)」が付きます。
- マトリックスのエクスポート:モデルでベースラインを選びます。
- プロジェクトのベースラインはモデル全体を保持するため、どのマトリックスもそこから機能します。
- ドキュメントのベースラインは、ドキュメント、その項目、それらにリンクされたエンティティを保持します。そのドキュメントのマトリックスは完全です。ドキュメントの外に及ぶマトリックス(プロジェクト全体、またはインターフェースや N² のマトリックス)には、注記「Built from a document baseline, which holds only that document and the entities linked to it.」(そのドキュメントとそれにリンクされたエンティティだけを保持するドキュメントのベースラインから作成されています。)が付きます。
テストレポート
テストレポートは、1 つのテストサイクルの結果を示します:何をどの構成でテストしたか、何が合格・不合格だったか、それがどの要求を検証するか。
- テストセンターで、新しいサイクルを開始…でテストサイクルを記録します。コンフィギュレーション / ビルドと供試体を入力します(どちらも、実行で最も多く記録された値が最初に入っています)。
- スイートのカードで ⋯ を開き、テストレポート…を選択します。または ⋯ → Test Cycles… を開き、サイクルのレポート…をクリックします。
- テストレポートをエクスポートでテストサイクルを選び、エクスポート形式で Test report (Word)、(Excel)、(CSV)、(HTML) のいずれかを選んで、エクスポートをクリックします。
Word のレポート(既定)には次の節があります。
- Identification:テストスイート、テストサイクル、結果の保存日時、レポートの作成日時。
- Test Environment and Configuration:構成またはビルド、供試体、テスト担当者、実行日。
- Summary of Results:ステータス別の件数と合格率。
- Results by Test Case:テストケースごとに 1 行。
- Detailed Results:テストケースごとの期待結果と実際の結果、テスト担当者、日付、構成、供試体、証拠ファイル、ステップの結果。
- Deviations and Open Issues:不合格とブロックされたテストケースと、リンクされた Issue。
- Test Evidence:サイクルで記録された証拠ファイル。
- Requirement Verification Status:スイートが検証する要求と、このサイクルの結果によるそのステータス。
Excel では 3 つのシート(Results、Steps、Requirements)が、CSV と Web ページでは結果の表が出力されます。結果は保存されたときのサイクルから取られるため、スイートをリセットしてもレポートは変わりません。名前、検証された要求、Issue は現在のモデルから取られます。ステップの結果と証拠が保持されるようになる前に保存されたサイクルでは、それらのフィールドは「—」と表示されます。
結果の表をドキュメントに入れるには、Test Report のマトリックスブロックを挿入します(上記を参照)。
ドキュメントとエクスポートに区分表示を付ける
区分表示とは、エクスポートするすべてのものに Holarch が印刷するテキストです:各ページの上部のヘッダー、各ページの下部のフッター、最初のページの通知。プロジェクトまたは組織に一度設定すれば、すべてのエクスポートに付きます。ドキュメントでは独自のものに置き換えられます。
注:ホスト型サービス(app.holarch.app)では、CUI、機密情報、輸出管理対象の情報を保持できません(利用規約)。そこでは標準の一覧から Distribution Statement B~F と輸出管理の表示が除かれ、CUI、機密区分(SECRET//NOFORN など)、ITAR、EAR、輸出管理、または Distribution Statement B~F を示す区分表示は保存されません:「Holarch's hosted service can't hold CUI, classified or export-controlled information, so this marking can't be used here. Remove it, or use the desktop app or a self-hosted installation.」(Holarch のホスト型サービスでは CUI、機密情報、輸出管理対象の情報を保持できないため、この区分表示はここでは使えません。除去するか、デスクトップアプリまたはセルフホスト型のインストールを使ってください。)Company Confidential、Distribution Statement A、著作権、契約番号などの会社の通知は引き続き使えます。このルールより前に設定された区分表示は保持され、引き続き印刷されます。変更するには、制限された部分を除去します。
デスクトップアプリとセルフホスト型のインストールでは、一覧全体が提供され、どのような区分表示も受け付けます。区分表示は自分で選ぶテキストです。Holarch はそれを印刷しますが、取り扱いのルールは強制せず、組織独自の管理が適用されます。どのエディションでも、区分表示に輸出管理の表示が含まれると、そのプロジェクトでは AI がオフになります。
標準の区分表示の一覧でテキストが入力されます。
| 標準の区分表示 | 見出し | フッター | 通知 |
|---|---|---|---|
| 会社専有情報 | COMPANY PROPRIETARY | COMPANY PROPRIETARY | 会社の名前を示す専有情報の通知 |
| Company Confidential | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | 会社の名前を示す機密保持の通知 |
| Distribution Statement A~F(B~F:デスクトップアプリとセルフホスト型のみ) | (なし) | DISTRIBUTION STATEMENT A to F | その記述の DoD 標準の文言(DoDI 5230.24)。理由、決定日、管理部署が入力されます |
| 輸出管理の表示(ITAR/EAR)(デスクトップアプリとセルフホスト型のみ) | (なし) | Export-controlled technical data. See the notice on the first page. | ドキュメントに ITAR(22 CFR 120–130)または EAR(15 CFR 730–774)の対象となる技術データが含まれている可能性があることの警告 |
| 著作権 | (なし) | © 年 著作権者. All rights reserved. | (なし) |
| 契約番号 | (なし) | Contract No. 契約番号 | (なし) |
空のままにした入力欄は、[reason] のような角かっこ付きのプレースホルダーとしてテキストに残ります。その場合、エディターに「エクスポートする前に、角かっこ内の部分を入力してください。」と表示されます。
プロジェクトの区分表示を設定する
- ⌘K / Ctrl+K を押してプロジェクトの区分表示…を選択します。ドキュメントのページ設定…や、開いているプロジェクトのプロジェクトの環境設定…(ホームのホーム ▾)からも開けます。
- 独自の区分表示を選択します。
- 標準の区分表示で項目を選び、そのフィールド(たとえば会社)を入力して、区分表示に追加をクリックします。
ヘッダー、フッター、通知が入力されます。別の項目を追加すると組み合わせられます:ヘッダーとフッターは「 · 」でつながれ、各通知はそれぞれ独立した段落になります。
- 必要に応じてテキストを編集し、保存をクリックします。
トーストに「プロジェクトの区分表示を保存しました。」と表示されます。プロジェクトの区分表示を変更できるのはプロジェクトのオーナーだけです。他のメンバーには読み取り専用で表示されます。
クリアは 3 つのフィールドを空にします。区分表示なしは、組織に区分表示がある場合でも、プロジェクトの区分表示をオフにします。
組織の区分表示を設定する
- アカウントメニューを開いて組織設定を選び、組織を開きます。
- ドキュメントの区分表示の下で区分表示を編集…をクリックします。
- プロジェクトと同じように区分表示を設定し、保存をクリックします。
トーストに「組織の区分表示を保存しました。」と表示されます。独自の区分表示を持たない組織のすべてのプロジェクトに適用されます。変更できるのは組織の管理者だけです。
ドキュメントに独自の区分表示、表紙、ページ番号を付ける
- ドキュメントで納品 ▾を開き、ページ設定…を選択します。
- 区分表示の下で、次のいずれかを選びます。
- プロジェクトまたは組織の区分表示(既定):下の行に、ドキュメントが使う区分表示が示されます。
- 独自の区分表示:プロジェクトと同じようにヘッダー、フッター、通知を設定します。
- 区分表示なし:ドキュメントとそのエクスポートには区分表示が付きません。
- 残りを入力します。
- Cover page(バージョンと作成者付き)。表紙には通知も表示されます。
- Word エクスポートでの Page numbers(「Page X of Y」)。
- 適用をクリックします。
トーストに「ページ設定を保存しました。」と表示されます。ヘッダーとフッターはドキュメントの上部と下部に、通知はタイトルの下に表示されます。⌘Z / Ctrl+Z で変更を 1 ステップで元に戻します。
最も近い区分表示が優先されます:ドキュメント独自のもの、なければプロジェクトのもの、それもなければ組織のもの。
区分表示が印刷される場所
- ドキュメントビューと印刷または PDF…:各ページの上部と下部にヘッダーとフッター、タイトルの下に通知。
- Word エクスポート(納品 ▾ → {template} (Word)、またはすべてのエクスポート…の Document (Word)):ヘッダーとフッターはすべてのページで繰り返され、選んだ場合はページ番号も付き、表紙が通常のタイトルの代わりになります。ドキュメント内のライブのマトリックスブロックは、上にタイトルのある Word の表になり、同じ列幅と I/A/D/T の見出しを持ち、ギャップは赤く網掛けされます。
- マトリックスをエクスポートと Traceability matrix (Word) または (HTML)。
- その他の Word ファイル:ICD ドキュメント、プレゼンテーション、ダイアグラム、Breakdown (Word) のエクスポートでは、すべてのページにヘッダーとフッター、タイトルの下に通知が付きます。
- Excel のレポート:ヘッダーとフッターは各シートのページヘッダーとページフッターに入り、Excel のページレイアウト表示で表示され、印刷されます。
- CSV:Table (CSV) で1 行目に区分表示にチェックを入れた場合だけです。既定ではオフなので、ファイルはそのまま再インポートできます。
- ダイアグラムの画像:PNG と SVG のエクスポートでは、ダイアグラムの上にヘッダーの帯、下にフッターと通知の帯が付きます。Web ページ(HTML)のエクスポートでは、ページの上部と下部に表示されます。サムネイルとドキュメント内のダイアグラムの画像には区分表示は付きません。
- プレゼンテーション:PowerPoint、Web ページ、PNG、SVG のスライドでは、すべてのスライドにヘッダーとフッター、最初のスライドに通知が表示されます。
- コンパイルには独自のページ設定があり、コンパイルをエクスポートするときに使われます。
モデルチェック
モデルチェックは、削除されたものを指すライブ値やライブテーブルを報告します(ルール Global.7、「存在しない対象を指すライブ値」):
- エンティティが削除されたライブ値には「{Entity: … Not found}」と表示されます。
- 範囲のドキュメントが削除されたマトリックスブロック、テストスイートまたはテストサイクルが削除された Test Report ブロック、または関係が存在しなくなったカスタムマトリックス。
- 存在しないクラス、ラベル、関係、ドキュメントをクエリで指定している件数または合計やライブテーブル。
- 項目、図、表が削除された相互参照。
説明を開き、ライブ値を編集または除去するか、存在するターゲットに対してもう一度挿入します。モデルチェックを参照してください。
ヒント
- RVTM または VCRM を検証の節として仕様書の末尾に置きます。レビューまで最新の状態に保たれます。
- レビューパッケージには、コンパイルを作成し、独自のページ設定で表紙と区分表示を付けます。
- 書き込みを行うレビュー委員会には VCRM を Excel にエクスポートし、ドキュメント内のライブブロックはそのまま残します。
- インテグレーションレベル別に構成した検証計画には、検証レベル別 VCRMを使い、先に各要求の検証レベルを設定します。
- インターフェース管理文書では、システムの Asset に範囲を絞ったInterface Matrixを挿入します。その子と Conduit が対角線上とセルに表示されます。