要求
要求
要求を作成、チェック、承認、ベースライン化、インポートし、未解決の TBD/TBR 項目と確認するリンクを追跡します。
概要
要求ページを使って、要求を書き、チェックし、承認し、ベースライン化し、まだ未解決のものを追跡します。要求は LML クラス Requirement のエンティティです。システムが持つべき能力、特性、品質要因を表します。
要求は通常、要求ドキュメントに置かれます(ドキュメントを参照)。それでも各要求はモデル内のエンティティです。そのため、同じ要求がデータベース、ダイアグラム、トレーサビリティマトリックス、RVTM に表示されます。
ナビゲーションレールのニーズと要求グループには、すべての要求ページがあります。
| ページ | 表示内容 |
|---|---|
| ドキュメント | 仕様書とそのアウトライン。要求はここで書きます。 |
| 要求 | すべての要求を 1 つの表に表示します(class:Requirement で絞り込んだデータベース)。 |
| 品質 | 要求の品質:要求ごとの 9 つの基準によるスコア。 |
| TBD/TBR | まだ決定またはレビューが必要な未解決の値の登録簿。 |
| 確認が必要なリンク | リンクの前回のレビュー後に上流の要求が変更されたリンク。 |
| 承認 | Status が In Review の要求。 |
| インポートとエクスポート | Word、Excel、CSV、ReqIF、プレーンテキスト、XMI、プロジェクトファイルのインポートを 1 つのドロップゾーンで行い、モデルのエクスポートも行います。 |
ベースラインはレビューのための凍結されたスナップショットです。ドキュメントから、または管理とレビュー → ベースラインとバージョンから作成します。機能、アセット、テストへのリンクについてはトレーサビリティで説明しています。
概念
Requirement と Statement
Statement は Requirement の親クラスです。
- 拘束力のないテキスト(節の見出し、仮定、背景)には Statement を使います。
- 拘束力のある「shall」文ごとに Requirement を使います。
品質チェックでスコアが付けられ、TBD/TBR 登録簿に載り、変更時にレビュー対象になり、RVTM で数えられるのは Requirement だけです。Statement は対象外です。
要求には、共通のエンティティフィールド Number、名前、説明があります。説明は要求文そのもので、リッチテキストです。残りは以下の属性で補います。
要求の属性
| 属性 | 型と値 | 意味 |
|---|---|---|
| 根拠 | 長いテキスト | 要求の背景にある理由。 |
| ステータス | Draft、In Review、Approved、Rejected | 承認ワークフローにおける要求の位置。 |
| 優先度 | High、Medium、Low | ステークホルダーにとっての要求の重要度。 |
| Criticality | High、Medium、Low | 要求が満たされない場合のミッションまたは安全への影響。 |
| 所有者 | テキスト | 要求に責任を持つ人またはチーム。 |
| 出所 | テキスト | 要求の出所となるステークホルダー、ドキュメント、規格。 |
| Verification Method | 複数選択:Analysis、Demonstration、Inspection、Test | 要求の検証方法。 |
| 検証レベル | Component、Subsystem、System | 要求を検証する組立レベル。 |
| 成功基準 | 長いテキスト | 要求が満たされたことを示す測定可能な結果。 |
| TBD/TBR | None、TBD、TBR | TBD = 値がまだ決定されていない、TBR = 値のレビューが必要。解決したら None に戻します。 |
| TBD Owner | テキスト | TBD/TBR の解決に責任を持つ人。 |
| TBD Due Date | 日付と時刻 | TBD/TBR を解決すべき期日。ワークフローグループの期限は同じ日付を表示・設定します(TBD/TBR 登録簿を参照)。 |
| 品質スコア | パーセント、計算値 | 前回の品質チェックの結果。 |
| Appropriate、Complete、Conforming、Correct、Feasible、Necessary、Singular、Unambiguous、Verifiable | Yes/No、計算値または手動で設定 | 9 つの品質基準。 |
インスペクターは要求のフィールドをグループにまとめます(インスペクターを参照):Requirement(Number、Name、Description、Labels、Rationale、Source、Success Criteria)、ワークフロー(Status、Priority、Criticality、Owner、Assignee、Due date、TBD/TBR、TBD Owner、TBD Due Date を含むレビューストリップ)、検証(Verification Method と Level、Verified by、Formal program を含むクローズのフィールド)、値(Budget Quantity、Threshold、Objective と現在の Value、Units)、適合性(Formal program)、品質。
スコアと 9 つの基準は品質グループにあり、最初は折りたたまれています。見出しには、たとえば「89% · 8 of 9 met」や「not checked yet」と表示されます。グループを開いたままにしたかどうかは、クラスごとに記憶されます。
プロジェクトでは独自の要求属性と選択肢を追加できます。スキーマ拡張を参照してください。
要求のラベル
ラベルは、クラスを変えずに要求を分類します。組み込みの要求ラベルは次のとおりです。
- Functional Requirement、Performance Requirement、インターフェース要求。
- Environmental Requirement、Reliability Requirement、Safety Requirement。
- Verification Requirement。
- Stakeholder Need:システム要求に変換される前の、ステークホルダーが述べたニーズ。
Verification Method はラベルグループでもあり、ラベル Analysis、Demonstration、Inspection、Test を持ちます。ラベルと属性は同じ元に戻す操作の中で同期します。
- ラベル Test を追加すると、Verification Method が Test に設定されます。
- 属性で Test を選ぶと、ラベルが追加されます。
ラベルだけを持つ古いプロジェクトやインポートは、プロジェクトを開いたときに属性へ統合されます。
要求のワークフロー
各要求は 4 つのステータスを経ます。
- 下書き:作成中。
- In Review:決定待ち。承認ページに一覧表示されます。
- Approved または Rejected:決定済み。各決定には、誰がいつ行ったかと、任意の理由が記録されます。
承認後は、3 つの仕組みで記録の正確さを保ちます。
- 編集時の再レビュー。Approved の要求の名前または説明を編集すると、「承認後にテキストが変更されました」という注記とともに In Review に戻ります。
- 古い品質結果。名前または説明を編集すると、品質結果が古い状態になり、品質の手動上書きがクリアされます。
- 確認が必要なリンク。名前、説明、または主要な属性を編集すると、その下流の項目へのリンクがレビュー対象になります。
3 つとも編集の一部であるため、1 回の元に戻す(⌘Z / Ctrl+Z)でまとめて取り消せます。
未解決項目:TBD、TBR、TBS
未解決項目とは、まだ確定していない値です。次のいずれかに当てはまる要求は未解決項目です。
- TBD/TBR属性が TBD または TBR である。
- 名前または説明に TBD、TBR、TBS という語が含まれている。
未解決項目は、解決されるまで TBD/TBR 登録簿に表示されます。
ベースライン
ベースラインは読み取り専用のスナップショットです。2 種類あります。
- ドキュメントのベースラインは 1 つのドキュメントを保持します。ドキュメントのアーティファクト、その項目と属性、それらに接する関係、1 ホップ先のエンティティ、ドキュメントのアウトライン設定が含まれます。
- プロジェクトのベースラインは、プロジェクト内のすべてのエンティティと関係を保持します。
ベースラインには承認記録(名前、役割、記述、日付)を付けられます。記録は保存するとロックされます。
使い方
使う場面と理由
要求の作業は、システムズエンジニアリングの V の左側にわたります。
- ステークホルダーのニーズを把握します。
- システム要求を導出します。
- 各要求文が適切な形式かチェックします。
- 要求の承認を得ます。
- レビュー(SRR、PDR、CDR)で凍結します。
ベースライン後は、作業が変更管理に移ります。すべての変更は再レビューされ、下流への影響がチェックされます。未解決の TBD/TBR の値は、設計を確定する前に解決します。
要求ページは次の問いに答えます。
| 質問 | ページ |
|---|---|
| 各要求は適切に書かれているか。 | 品質 |
| まだ不明な値はどれか、担当者は誰か、期限を過ぎていないか。 | TBD/TBR |
| 要求が変更されたため、何を再チェックする必要があるか。 | 確認が必要なリンク |
| 何が決定待ちか。 | 承認 |
| レビュー以降に何が変わったか。 | ドキュメントのバージョン ▾ → 版を比較…、ベースラインとバージョン |
| 各要求は割り当てられ、検証されているか。 | トレーサビリティマトリックスと RVTM |
品質、確認するリンク、TBD/TBR、承認の各ページは、レールのニーズと要求の下に並んでいます。そこから 4 つのチェックを順に行います。
要求を書く
- ニーズと要求 → ドキュメントを開きます。
- 要求ドキュメントを開きます。
新しく始めるには、+ 新しいドキュメントをクリックします(ドキュメントを参照)。
- ドキュメントの下のクイック追加バーで、項目の追加先(たとえば Under 3 Electrical Power)を選択します。
- 要求文を入力して Enter を押します。
ドキュメントの既定のクラス(要求ドキュメントでは Requirement)の項目が追加されます。兄弟項目に続いて番号が付きます。
- 要求を選択した状態で、右側のインスペクターを開きます。
- Requirement グループで根拠、Source、成功基準を、ワークフローで優先度、Criticality、Owner を、検証で Verification Method と検証レベルを入力します。
- インスペクターの Requirement グループの+ ラベルで種類のラベル(たとえば Performance Requirement)を追加します。(ラベル列は表示 ▾ → 列 ▸にあります。)
要求の Status は Draft になり、ニーズと要求 → 要求に表示されます。
値がまだわからない場合:
- 要求文には最善の見積もりを書きます。
- TBD/TBR を TBD に設定します。
- TBD Owner を入力し、ワークフローグループの期限に日付を設定します。
要求は、その期限とともに TBD/TBR 登録簿にも表示されるようになります。
記述をチェックする
- ニーズと要求 → 品質を開きます。
ドキュメントからは、代わりにチェック ▾ → 品質をチェックを選択します。
- 範囲バーですべての要求またはドキュメント: <name>を選択します。
- ページヘッダーの品質をチェックをクリックします。
トーストに「32 件の要求をチェックしました」(または実際の件数)と表示されます。各要求に 0 から 100% のスコアと、基準ごとの ✔ または ✘ が付きます。
要求が 2,000 件を超える場合、チェックはバックグラウンドで実行されます。進行状況カードに「要求をチェック中」、件数、残り時間が表示され、作業を続けられます。停止するにはカードのキャンセルをクリックします。何も変更されません。その後、カードに「品質結果を保存中」と保存済みの件数が表示されます。保存中は、他の編集が「品質結果を保存しています。完了してからもう一度お試しください。」として拒否されます。結果が変わった要求だけが保存されるため、変更なしで再チェックしても何も保存されません。チェック全体が 1 つのステップです。⌘Z / Ctrl+Z を 1 回押すと取り消されます。
- タイルを読みます:要求、平均スコア、良好 (≥ 67%)、要修正 (< 67%)、該当するものがある場合は古い結果(テキスト変更あり)。
- 67% 未満の各要求について、提案列を読みます。
または、✘ にポインターを合わせると、その基準のメッセージが表示されます。
- 要求の名前をクリックして開き、テキストを修正します。
- チェックをもう一度実行します。
Correct と Feasible には常に人の判断が必要です。他のチェックの結果にかかわらず、チェックがこれらを満たしたと判定することはありません。そのため、自動チェックで到達できるのは最大で 9 基準中 7(78%)です。検証するテストケースまたは要求がない要求は 9 基準中 6(67%)です。要求ごとに、これらは自分で判断します。
- 要求をレビューしたら、✘ をクリックしてその基準を「はい」にします。
- 最初の意見を得るには、✦ AI ▾ → AI でチェック(N 件の要求)…(AI 要求チェック)を使います。
注:以前のバージョンで保存されたスコアでは、別のチェックが不合格でも Correct や Feasible が満たされたと数えられることがありました。チェックをもう一度実行して更新してください。
EARS テンプレートで書く
EARS(Easy Approach to Requirements Syntax)は、各要求を 1 つの文で書きます。任意の条件の後に「the [system] shall [response]」を続けます。条件の最初の語がパターンを決めます。
| パターン | テンプレート | 例 |
|---|---|---|
| Ubiquitous | The [system] shall [response]. | The pump controller shall record every start command with its time.(ポンプコントローラーは、すべての起動コマンドをその時刻とともに記録すること。) |
| Event-driven | When [trigger], the [system] shall [response]. | When the tank level falls below 20 %, the pump controller shall start the backup pump.(タンクの液位が 20 % を下回ったとき、ポンプコントローラーは予備ポンプを起動すること。) |
| State-driven | While [state], the [system] shall [response]. | While the vehicle is charging, the battery manager shall keep each cell below 45 °C.(車両の充電中、バッテリーマネージャーは各セルを 45 °C 未満に保つこと。) |
| Unwanted behavior | If [unwanted condition], then the [system] shall [response]. | If the supply voltage drops below 10 V, then the flight computer shall switch to the reserve battery.(供給電圧が 10 V を下回った場合、フライトコンピューターは予備バッテリーに切り替えること。) |
| Optional feature | Where [feature is included], the [system] shall [response]. | Where a heated windshield is fitted, the climate controller shall clear frost within 5 minutes.(ヒーター付きフロントガラスを装備している場合、空調コントローラーは 5 分以内に霜を除去すること。) |
| Complex | While [state], when [trigger], the [system] shall [response]. | While the drill is in standby, when the operator presses Start, the drill controller shall reach full speed within 3 s.(ドリルの待機中にオペレーターが Start を押したとき、ドリルコントローラーは 3 s 以内に全速に達すること。) |
- インスペクターまたは項目ビューで要求を開きます。
- 説明の横にある EARS ▾ をクリックします。
1 行目に要求文のパターン(✓ Event-driven)、または修正すべき点(No EARS pattern: 1 to fix)が表示されます。
- パターンを選択します。
そのテンプレートが説明になります。要求にすでに説明がある場合は置換で確定します。古い要求文は項目の履歴に残ります。⌘Z / Ctrl+Z を 1 回押すと元に戻ります。
- 角かっこ内の語を置き換えます。
すべての要求をチェックするには、モデルチェック → 設定で Requirement.11 を警告またはエラーに設定します。既定ではオフです。
SysML v2 プロジェクトでは、EARS ▾ はインスペクターで要求のドキュメントの下にあり、その doc コメントを書きます。
要求を承認する
- 要求の準備ができたら、その Status を In Review に設定します。
これはインスペクター(ワークフローグループのレビューストリップにある Status)、データベース、またはドキュメントの列で行います。
- レビュー担当者がニーズと要求 → 承認を開きます。
このページには、Status が In Review のすべての要求が一覧表示されます。
- 行をクリックします。
インスペクターのワークフローグループにレビューストリップが表示されます。Status、それを誰がいつ設定したか(「by J. Rivera · Mar 9, 2026 at 9:58 AM」)、ボタンが表示されます。
- 承認をクリックします。
または却下…をクリックし、必要に応じて理由を入力します。
トーストに「承認しました」または「却下しました」と表示されます。決定はあなたの名前と時刻とともに記録され、要求は承認の一覧から外れます。
要求がベースラインに含まれ、検証項目やドキュメントがそれにトレースしている場合、承認はまず、それらを再レビューが必要の下に一覧表示するダイアログを開きます(影響)。行をクリックして確認してから、承認をクリックして確定します。
決定済みの要求をレビューに戻すには、再オープン をクリックします。トーストに「レビュー中に移動しました」と表示されます。
プロジェクトに要求の Status のワークフロー(スキーマ → ワークフロー)がある場合、レビューストリップには承認、却下…、再オープン の代わりにそのワークフローの遷移が表示されます。承認が必要な遷移は … で終わり、承認を要求を開きます。状態変更の承認を要求するを参照してください。ベースライン化された要求では、承認を要求と変更要求の承認…ダイアログに同じ再レビューが必要の一覧が表示されます。
レビューのためにドキュメントを凍結する
- ドキュメントの表題欄でバージョン ▾をクリックします。
- ベースラインを保存…を選択します。
または納品 ▾ → バージョン ▸ ベースラインを保存…を選択します。
- 名前はそのままにするか変更します。既定は「<document> Baseline <n>」です。
- 承認の下で、承認者ごとに 1 行ずつ名前、役割、Statement(既定は「Approved for release.」)を入力します。
+ 承認者を追加で行を追加し、× で行を除去します。
- 作成をクリックします。
トーストに「ベースラインを保存しました」と表示されます。バージョン ▾には「Current · last baseline <name>」と表示されます。
以後、最新のベースラインと異なる行には変更バーが付きます。
ベースライン後の変更を扱う
- ドキュメント内で要求のテキストを編集します。
トーストに結果の要約が表示されます。たとえば「承認済みの要求 1 件をレビュー中に移動しました。6 件のリンクをレビュー対象にしました。」。編集の一部として次のことが行われます(1 回の元に戻すですべて取り消せます)。
- Approved の要求が In Review に移ります。
- 品質結果が古い状態になります(「Quality: stale — re-run」)。
- 下流のリンクがレビュー対象になります。
- ニーズと要求 → 確認するリンクを開きます。
- 各行で差分をクリックしてテキストの変更を確認し、リンクされた項目をレビューします。
- リンクされた項目がまだ有効な場合は、その行のレビュー済みにする…をクリックします。
複数をまとめてレビュー済みにするには、行を選択して選択したものをレビュー済みにする…をクリックします。
- 確認した内容を書き、レビュー済みにするをクリックします。
- 品質チェックをもう一度実行します。
- 要求をもう一度承認に回します。
- バージョン ▾ → 版を比較…をクリックし、From でベースラインを、To で現在のバージョンを選択します。
レポートには、ベースライン以降のすべての変更が一覧表示されます。
- 変更委員会向けには変更(Excel)をクリックします。
TBD と TBR の項目を解決する
- ニーズと要求 → TBD/TBR を開きます。
- タイルを読みます:未解決の TBD/TBR、Overdue、オーナーなし、ドキュメントごとの件数。
- 期限切れの行を最初に処理します。これらの行は色付きで、期限の下に「Overdue」と表示されます。
- 担当者が「—」と表示されている場合は、TBD Owner を割り当てます。
- 値が確定したら、要求のテキストを最終的な値に編集します。
- 行の閉じるをクリックします。
閉じると TBD/TBR が None に設定され、行は登録簿から外れます。
登録簿を担当者に送るには、XLSX をエクスポートをクリックします。
既存の仕様書をインポートする
- ニーズと要求 → インポートとエクスポートを開きます。
- ファイルをドロップゾーンにドロップするか、ドロップゾーンをクリックしてファイルを選択します:Word(.docx)、Excel または CSV、ReqIF、プレーンテキスト。
ステータス行には、たとえば「Analyzed “SRS.docx”: 48 rows, 5 columns.」と表示されます。形式には検出された形式が表示されます。
- 続行をクリックします。
- 各列のマッピング先を確認し、クラスのない行のクラスを Requirement に設定します。
- 続行をクリックします。
- Create a requirements document from these N requirements にチェックを入れたまま、ドキュメントの種類と名前を確認し、新しい項目と更新された項目、警告を確認します。
- Import N items をクリックします。
警告がなければ、新しいドキュメントが開きます。警告がある場合は、インポート完了カードに一覧表示されます。
インポート完了カードには、ドキュメント、データベース、Spider 図またはツリー図、品質チェックを開くボタンがあります。⌘Z / Ctrl+Z を 1 回押すとインポート全体が取り消されます。
実例:CubeSat EO-1 のデモ
プロジェクトを管理からデモプロジェクト CubeSat EO-1 — Earth Observation Demo を作成します。32 件の要求からなる仕様書 SRS-001 EO-1 System Requirements Specification があり、SRR ベースラインとその後の変更が含まれています。
品質。
- ニーズと要求 → 品質を開き、品質をチェックをクリックします。
タイルには、32 件の要求、平均 92%、良好 29 件、要修正 3 件が表示されます。
弱い 3 件の要求は意図的にそのように書かれています。それぞれのスコアは 44% です。
- 2.5 Safe Mode Recovery:「The spacecraft should recover from safe mode quickly and resume imaging as appropriate」。提案には次のものがあります。
- 「R34 - 測定できない性能に関する表現:[quickly]」
- 「R8 - 逃げ道となる表現が要求を弱めています:[as appropriate]」
- 「R19 - 2 つの要求を結合しています。別々の要求に分割してください:[and]」
- 「文をピリオドで終えてください。」
- 「Link a Test Case or Requirement that verifies it.」(検証する Test Case または Requirement をリンクしてください。)
- 3.5 Battery Thermal Control:「…keep the battery warm enough (TBD).」。提案は「R21 - かっこが含まれています。かっこ内のテキストを根拠に移してください。」と「TBD/TBR のプレースホルダーを置き換えてください。」です。
- 6.4 Operator Interface:「…shall be user friendly and/or easy to use.」。提案は「R34 - 測定できない性能に関する表現:[user friendly, easy to use]」と「R19 - 「and/or」は曖昧です。両方か一方かを明記してください:[and/or]」です。
2.5 を修正するには:
- 「The spacecraft shall resume imaging within 6 hours of a safe mode entry.」と書き直します。
- verified by でテストケースをリンクします。
- チェックをもう一度実行します。
結合、逃げ道となる表現、あいまいな語のメッセージが消えます。
TBD/TBR。TBD/TBR を開きます。3 件の未解決項目が表示されます。
- 3.5 Battery Thermal Control:Thermal Engineer が担当する TBD。期限を過ぎています。
- 2.4 Target Slew(ADCS Lead)と 5.3 Downlink Link Margin(Comms Lead):期限がまだ先の TBR。
ベースライン後の変更。ドキュメントのバージョン ▾に SRR Baseline が表示されます。これは J. Rivera(Systems Lead)、R. Okafor(Mission Principal Investigator)、L. Brandt(Program Manager)が承認しました。
SRR の後、要求 3.1 Orbit Average Power が 28 W から 30 W に変更されました。3.1 は Approved だったため、「承認後にテキストが変更されました」という注記とともに In Review に戻りました。
確認するリンクには、3.1 からの 6 つのリンクが一覧表示されます。
- 1.3.1 Solar Arrays
- F3 Generate and Store Power と F3.1 Convert Sunlight to Power
- EQ-1.1 Solar Power Generation と EQ-1.4 Power Margin Check
- TC-06 Solar Array Power Test
任意の行で差分をクリックします。「28 W」に取り消し線が引かれ、「30 W」が挿入されています。次に項目をレビューします。
- TC-06 はピーク電力 ≥ 72 W を期待し、75.1 W を測定しています。EQ-1.3 Orbit-Average Array Power(ピーク × 日照率 0.62 × 電力経路効率 0.6)を通すと、75.1 W は軌道平均 27.9 W となり、新しい 30 W を下回ります。このリンクはレビュー済みにせず、「75.1 W peak = 27.9 W orbit average; re-test against about 80.6 W peak」というコメントを追加します。このテストには新しい期待結果と新しい実行が必要です。
- 1.3.1 をレビュー済みにする前に、太陽電池アレイのサイジングがまだ成立するかチェックします。
現在と比較。バージョン ▾で SRR Baseline を選択し、そのバナーの現在と比較をクリックします。レポートには次の内容が一覧表示されます。
- 3.1 の Description、Rationale、Status、Quality Score の変更。
- 2.4 Target Slew の Status の変更(Draft → In Review)。
- 新しい要求 4.4 Downlink Encryption と、その 2 つの新しい satisfies リンク。
承認。承認を開きます。3.1、1.5 Daily Collection Volume、5.3 Downlink Link Margin を含む 9 件の要求が In Review です。
ヒントとよい進め方
- 要求ごとに「shall」を 1 つ使い、能動態で、数値、単位、条件を含めて書きます。品質チェックはまさにそれを評価します。
- 理由は要求文ではなく根拠に書きます。目的を表す語句(「so that」「in order to」)とかっこは R20 と R21 として指摘されます。
- 書きながら Verification Method を入力します。方法があってテストケースがない要求は、RVTM で Unverified ではなく Planned-only と表示されます。
- テキストに「TBD」と入力するだけでなく、担当者と期限を付けて TBD/TBR を設定します。属性があると、登録簿で担当者と期限を追跡できます。
- 各レビューの前にベースラインを作成します。変更バーと現在と比較は、ベースラインに対してのみ機能します。
- リンクはコメントを付けてレビュー済みにします。コメントはリンクされた項目に追加され、リンクにも記録されるため、レビューの監査証跡が残ります。
よくある間違い
| 症状 | 原因 | 対処 |
|---|---|---|
| 要求にスコアが付かない、登録簿に載らない、または RVTM に含まれない。 | それは Requirement ではなく Statement です。 | インスペクターでクラスを Requirement に変更します。 |
| すべての要求で Correct と Feasible が ✘ になる。 | これらには人の判断が必要です(「Needs a reviewer’s judgment」)。 | それぞれをレビューし、✘ をクリックして「はい」にするか、AI 要求チェックを実行します。 |
| スコアに「古い結果 — 再実行」と表示される。 | 前回のチェック後にテキストが変更されました。 | 品質をチェックをクリックするか、テキストが変更されたら自動的に再チェックをオンにします。 |
| 手動の Yes/No の上書きが消えた。 | テキストを編集するとクリアされます。 | レビュー後に設定し直します。元に戻すで復元でき、履歴にも残ります。 |
| 誤字の修正後に要求が Approved のままにならない。 | 名前や説明を編集すると、承認済みの要求は必ず再オープンされます。 | もう一度承認します。誤字は承認前に修正します。 |
| TBD/TBR の行に「閉じる」がない。 | その未解決項目はテキストだけから来ています。 | テキストを編集して TBD、TBR、TBS を除去します。 |
| インポートで更新されずにコピーが作成された。 | Match existing entities by で一致しませんでした。 | ID 列を付けてエクスポートし、編集してから、Match existing entities by: Global ID でインポートします(スプレッドシートから要求を更新するを参照)。 |
他の機能との関係
- 入力元:インポートによるステークホルダーの意見と既存の仕様書、およびドキュメントで書かれたドキュメント。
- 出力先:
- AI:ドキュメントと項目ビューの ✦ AI ▾ メニューには、わかりやすく書き直し…、測定可能な基準を追加…、簡潔にする…、複合要求を分割…、根拠の下書きを作成…、名前を提案…、AI でチェック(AI 要求チェック)があります。AI による変更は適用前にプレビューされます。AI に質問と AI ツールを参照してください。
要求ページ
要求ページを使うと、すべての要求を 1 つの表で表示・編集できます。ニーズと要求 → 要求は、class:Requirement で絞り込んだデータベースです。
データベースのすべての機能がここで使えます。
- 列の並べ替えと絞り込み、セルのその場での編集。
- 行を選択して一括バーを使い、多数の要求の属性やラベルを一度に設定。
- 選択した行のエクスポートと、トレーサビリティマトリックスの表示。
行をクリックすると、インスペクターに要求が表示されます。ダブルクリックすると項目ビューが開きます。確認が必要なリンクを持つ要求の行には ⚠ レビューバッジが付きます。行を右クリックするとメニューが開きます:理由付きの最大 3 つのおすすめの操作(たとえば、要求が Unambiguous を満たさないときは ✦ Add Measurable Criteria…、検証されていないときは ✦ テストケースを生成…)、✦ More AI ▸、続いて Open、名前を変更…、複製、子を追加…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、リンクをコピー、Copy Number、削除…(右クリックメニューを参照)。
表、クエリ、一括編集についてはモデルとデータベースを参照してください。
便利なクエリ:
| クエリ | 表示するもの |
|---|---|
class:Requirement | すべての要求。 |
Requirement:"Status=In Review" | 承認の一覧。 |
Requirement:"Status=Draft" | まだレビューに回されていない要求。 |
class:Requirement AND is:leaf | 末端の要求(子要求がないもの)。 |
class:Requirement AND NOT relationship:"verified by" | 検証する項目がない要求。 |
要求の品質
品質ページ(タイトル「要求の品質」)を使って、表現の悪い要求を見つけます。各要求を 9 つの基準で採点します。
9 つの基準と提案に含まれるルール番号(R2、R19 など)は、INCOSE の Guide to Writing Requirements の特性とルールに従っています。Holarch の語リストとパターンはそれらのルールを近似したもので、ガイドの本文ではありません。一部のルールにはレビュー担当者の判断が必要です。
- スコア = 100 × (満たした基準の数)/ 9 を丸めた値。チェックされなかった基準(–、他の言語の要求を参照)は除外されます:100 × 満たした数 / 8。
- 67% 以上は良好です。67% 未満は要修正です。
- バーは 34% 未満で赤、34% から 66% で黄、67% 以上で緑です。
ページのレイアウト
- ページヘッダー:
- その他 ▾:手動評価をクリアは、表示中の要求の手動の Yes/No をすべてリセットし、チェックを再実行します。要求で開くは、表示中の要求を要求の表で開きます。ドキュメントを開くは、範囲がドキュメントのときに表示されます。
- エクスポート ▾:表示中の要求の Excel(.xlsx)と CSV。
- 品質をチェック:フィルターの表示にかかわらず、範囲内のすべての要求をチェックします(重複ルールは、各要求を範囲内の他の要求と比較します)。
- ✦ AI ▾(上部バー):AI でチェック(N 件の要求)…。表示中の要求の AI 要求チェックです。
- 範囲バー:Scope(すべての要求またはドキュメント: <name>)とチェックボックステキストが変更されたら自動的に再チェック。確認するリンク、TBD/TBR、承認はレールで品質の隣にあります。
- クエリバー:+ フィルター、フィルターチップと検索テキスト、クリア、?(検索構文)、ビュー ▾。要求ページと同じバーです(品質ページを絞り込むを参照)。
- タイル:要求(フィルターで一部が非表示のときは表示中の要求の下に「12 of 40」)、平均スコア、良好 (≥ 67%)、要修正 (< 67%)、古い結果があるときは古い結果(テキスト変更あり)。古いスコアは平均から除外されます。
- タイルの下の注記:「自動チェックで判定できるのは 9 属性中最大 7 属性(78%)です。Correct と Feasibleは人による確認が必要です。✘ をクリックすると「はい」になります。クリックするたびに、手動「はい」、手動「いいえ」、自動の順に切り替わります。」
- 表:Number、名前(下に説明)、品質スコア、基準ごとに 1 列、提案。提案には、基準を先頭に付けたすべてのメッセージが一覧表示されます。行は番号順に並びます。行を右クリックするか、行で Shift+F10 を押すと、データベースの行メニューが開きます:理由付きのおすすめの操作(不合格の基準を修正する書き直しが最初)、✦ More AI ▸、Open、名前を変更…、複製、子を追加…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、リンクをコピー、Copy Number、削除…。その行が選択されます。
- 複数の行:⌘ / Ctrl+クリック(Windows と Linux では Ctrl+クリック)で行を切り替え、⇧ / Shift+クリックで最後にクリックした行からの範囲を選択し、⌘ / Ctrl+⇧ / Shift+クリックでその範囲を追加します。フォーカスのある行で ⌘A / Ctrl+A を押すとすべての行を選択し、⇧ / Shift+↑ / ⇧ / Shift+↓ で選択範囲を広げます。ツールバーに件数が表示され、Esc で選択を解除します。選択した行を右クリックすると、すべての行に対して操作できます:✦ Check with AI (n requirements)…、✦ Rewrite (n) ▸、✦ Generate Test Cases (n)…、✦ Ask AI About These (n)…、✦ Suggest Traces (n)…(それぞれ 1 つのプレビュー付き。選択した複数の項目に対する AIを参照)、Duplicate n Entities、Set Status ▸、Set Priority ▸、Add to Document ▸、Delete n Items…。それぞれ 1 回の元に戻すで取り消せます。TBD/TBR 登録簿と確認するリンクも同じように動作します。確認するリンクでは、選択によって選択したものをレビュー済みにする…の対象の行にもチェックが入ります。
特殊なケース:
- 結果のない行には、スコア列に「未実行」と表示されます。
- 古い行には「古い結果 — 再実行」と表示されます。
- 範囲に要求がない場合、ページには「要求はありません」と「Only entities of class Requirement are scored; Statements are skipped.」と表示されます。
- フィルターまたは検索テキストですべての要求が非表示になった場合、ページには「一致する要求はありません」と「検索またはフィルターに一致する要求はありません。すべての要求を表示するにはクリアしてください。」と表示されます。
品質ページを絞り込む
クエリバーは要求ページと同じように動作します(入力したフィルターがチップになるしくみを参照):入力したフィルター語は Enter を押すとチップになり、残りのテキストは名前、番号、説明と照合されます。空の検索で Backspace を押すと最後のチップが除去され、クリアですべて除去されます。タイル、表、エクスポート ▾、✦ AI ▾ → AI でチェックはフィルターに従います。
+ フィルターには、範囲内の件数とともに次のものが一覧表示されます。
| グループ | フィルター | 用語 |
|---|---|---|
| 品質 | 良好 (≥ 67%)、要修正 (< 67%)、未実行、古い結果(テキスト変更あり)、手動評価、AI の指摘 | quality:good, quality:rework, quality:notrun, quality:stale, quality:manual, quality:ai |
| 基準を満たさない | 基準ごとに 1 つ:「いいえ」と評価されたもの | quality:Verifiable=no(=yes:「はい」と評価されたもの) |
| ルールの指摘 | 範囲内で見つかったルール。たとえば R7 Imprecise wording や R30 Closely resembles(重複の可能性) | quality:R7 |
| 構造、クラス、要求の属性、ラベル、関係、ダイアグラム | 要求ページと同じ。要求の属性はクラスのチップなしで一覧表示されます | is:tbd, Requirement:"Status=Draft", label:"…" |
同じグループのフィルターはまたはで、異なるグループはとで組み合わされます。スコアの範囲には属性を使います:Requirement:"Quality Score>=50"。quality: の語は要求ページとデータベースでも使えます。
ビュー ▾は、組み込みのビュー(要修正、まだチェックされていません、古い結果、あいまい、検証不可、重複の可能性、手動評価)または保存済みのビューを適用します。ビューを保存…は、現在のフィルターと検索テキストをこのブラウザーにすべてのプロジェクト共通で保存します。保存済みのビューを使用中は Delete "<name>" が表示されます。すべての要求はフィルターをクリアします。アドレス quality?q=<query> を開くと、絞り込まれたページが開きます。
絞り込みは保存された結果を読むだけで、再チェックはしません。50,000 件の要求でも、フィルターや検索の変更は 0.1 秒を大きく下回る時間で終わります。
基準とチェック
各基準には 3 つの記号のいずれかが表示されます。
- ✔(はい):メッセージなし。
- ✘(いいえ):少なくとも 1 つのメッセージ。
- –:チェックされていない。
チェックは大文字と小文字を区別せず、語と語句の全体で照合します。一覧にある形だけが対象です。「effective」と「effectively」はどちらも一覧にありますが、「effectiveness」はありません。引用符内の語も対象です。以下のメッセージは画面に表示されるとおりのテキストです。メッセージ末尾の角かっこ内の一覧は、見つかった語を示します。
Unambiguous(明確)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| R6 | R6 - 認識できない単位:標準の SI 単位、米国慣用単位、ヤード・ポンド法の単位を使用してください:[...] | 既知の単位ではない語が続く数値(たとえば「12 sorties」)。既知の単位には、SI 単位、米国慣用単位、ヤード・ポンド法の単位とその略語、%、degrees、°C、°F が含まれます。 |
| R2 | R2 - 能動態を使用してください:[...] | 「shall/must/will/should be」の後に過去分詞が続くもの(「shall be measured」)。 |
| R5 | R5 - 次の代わりに定冠詞(「the」)を使用してください:[...] | 「a」または「an」。 |
| R7 | R7 - 不正確な表現:[...] | some, many, several, few, little, much, various, appropriate(ly), adequate(ly), efficient(ly), effective(ly), sufficient(ly), reasonable, reasonably, suitable, suitably, significant(ly), minimal(ly), maximal(ly), approximately, almost, nearly, generally, usually, typically, normally, robust(ly), flexible, flexibly, easy, easily, etc, similar, relevant, substantial(ly), large, small, good, bad, better, best, worst, proper, properly, acceptable, acceptably, accurate(ly), extreme, high-contrast, high contrast. |
| R8 | R8 - 逃げ道となる表現が要求を弱めています:[...] | if necessary, where possible, as appropriate, as practicable, as far as possible, if practical, as required, as needed, to the extent possible, if possible. |
| R10 | R10 - 不要な不定詞句:[...] | to be designed to, to be able to, to be capable of, to enable, to allow, be able to, be capable of. |
| R16 | R16 - 否定を避けてください:[...] | not, n't, never. |
| R17 | R17 - スラッシュ(「/」)を避けてください。 | 2 つの語の間のスラッシュ。ただし km/h、m/s、and/or と、そのドイツ語、フランス語、スペイン語、イタリア語、オランダ語の同等表現は除きます。 |
| R24 | R24 - 明示的な名詞の代わりに代名詞が使われています:[...] | it, its, they, them, their, he, she, him, her, someone, something, anyone, anything, anybody, somebody, this, these, those. |
| R32 | R32 - 全称限定子の代わりに「each」を使用してください:[...] | all, any, both, every, everything, everyone. |
| R34 | R34 - 測定できない性能に関する表現:[...] | fast, quick, quickly, user friendly, user-friendly, high speed(s), high-speed, best practice(s), state of the art, state-of-the-art, seamless(ly), intuitive(ly), easy to use, timely, rapid, rapidly, real-time, real time.「Real-time clock」は対象外です。部品の名前だからです。 |
| R35 | R35 - 不明確な時間の表現:[...] | as, eventually, before, after, until, meanwhile, simultaneous(ly), soon, later, sometimes, occasionally, often, subsequently, previously. |
| — | TBD/TBR のプレースホルダーを置き換えてください。 | 説明内の TBD、TBR、TBS(大文字)。 |
| — | AI: ambiguous — <reason> | AI 要求チェックで受け入れた AI の指摘。 |
| — | 上限(「up to」)を示しています。下限の意味なら「at least」を使用してください。 | 数字または単語で書かれた数値が続く「up to」(「up to 72 hours」「up to five tonnes」)。「Up to date」は対象外です。 |
Complete(完全)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| — | Missing description.(説明がありません。) | 空の説明。 |
| — | Missing name.(名前がありません。) | 空の名前。 |
| R9 | R9 - 終わりのない列挙の表現:[...] | including but not limited to, etc, and so on, and so forth, such as, among others. |
Singular(単一)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| R18 | R18 - 1 つの文で書いてください(N 文あります)。 | 複数の文(。、!、? で終わる日本語と中国語の文も含む)。 |
| — | 文をピリオドで終えてください。 | 「.」(または 。)で終わらない説明。 |
| R19 | R19 - 2 つの要求を結合しています。別々の要求に分割してください:[...] | 2 つの動作または 2 つの義務をつなぐ and、or、but、however、whereas(「shall log and report each fault」「… and the operator shall …」)、「nor shall」、「;」の後の 2 つ目の節、2 つ目の動作の前の「and/or」。1 つに 2 つの要求(R19)を参照してください。 |
| R19 | R19 - 「and/or」は曖昧です。両方か一方かを明記してください:[and/or] | 値の間または条件内の「and/or」。 |
| R19 | R19 - 2 つの値を結合しています。それぞれ別に検証する場合は分割してください:[...] | 1 つの動作の後で 2 つの対象または値をつなぐ and、or(「measure the temperature and the humidity」)。注記です。Singular は「はい」のままです。 |
| R20 | R20 - 目的を表す語句が含まれています。根拠に移してください:[...] | purpose of, in order to, so that, for the purpose of, so as to. |
| R21 | R21 - かっこが含まれています。かっこ内のテキストを根拠に移してください。 | 「(」または「[」(全角のかっこも含む)。 |
Conforming(準拠)
| メッセージ | 検出条件 |
|---|---|
| 助動詞を使用してください:[need, shall, will, should, must] | これらの語がどれも含まれていない。 |
Appropriate(適切)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| R31 | R31 - 解決策を強制しています:[...] | using, by means of, utilizing, utilising, implemented in, implemented with, via a, via the, built with, written in. |
Necessary(必要)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| R30 | R30 - Closely resembles: [3.2 Battery Capacity (81.3% similar), ...] | 範囲内にある、説明の類似度が 75% 以上(文字ペアの類似度)の別の要求。指摘には最大 5 件の名前が挙げられ、残りは件数で示されます(「and 3 more」)。要求の直接の親と子(decomposed by、decomposes)は比較されません。詳細化では親の表現を繰り返すことが多いためです。兄弟の要求と無関係の要求は比較されます。 |
Verifiable(検証可能)
| メッセージ | 検出条件 |
|---|---|
| Link a Test Case or Requirement that verifies it.(検証する Test Case または Requirement をリンクしてください。) | 要求に、Requirement または Test Case への verified by リンクがない。 |
| AI: not verifiable as written — <reason> | AI 要求チェックで受け入れた AI の指摘。 |
Feasible(実現可能)
| ルール | メッセージ | 検出条件 |
|---|---|---|
| R26 | R26 - ほとんど達成できない絶対的な表現:[...] | always, never, 100%, 100 percent, all the time, totally, completely, absolutely, zero defects, forever, continuous, continuously, uninterrupted. |
| — | Needs a reviewer’s judgment(レビュー担当者の判断が必要) | 絶対的な表現も重複に近いものも見つかりませんでした。人が判断する必要があります。 |
Correct(正確)
| メッセージ | 検出条件 |
|---|---|
| Needs a reviewer’s judgment(レビュー担当者の判断が必要) | すべてのテキストチェック(Appropriate、Complete、Conforming、Necessary、Singular、Unambiguous)に合格しました。人が判断する必要があります。 |
Correct と Feasible は誰かが判断するまで「Needs a reviewer’s judgment」となるため、自動で得られる最高スコアは 9 基準中 7(78%)です。
1 つに 2 つの要求(R19)
要求は 1 つのことを述べます。R19 は「and」「or」「nor」「but」「however」「whereas」「as well as」「and/or」を 1 つずつ調べ、次のいずれかの種類に分類します。
| 種類 | 例 | 結果 |
|---|---|---|
| 2 つの要求 | 「The unit shall log and report each fault.」「The pump shall stop, and the operator shall be alerted.」「… to acknowledge alarms and to silence the horn.」「…; it shall also …」 | 指摘です。Singular は「いいえ」になります。 |
| あいまいな「and/or」 | 「The log shall record the user ID and/or the badge number.」 | 指摘です:両方か一方かを明記します。Singular は「いいえ」になります。 |
| 2 つの値 | 「The station shall measure the temperature and the humidity.」 | 注記です:各値を別々に検証する場合は分割します。Singular は「はい」のままです。注記は灰色で表示され、スコアは下がりません。 |
| 指摘なし | 「between 5 °C and 30 °C」、「When A and B, the unit shall …」、「… when the door is open and the fan is off」、「requirements 2.1 and 2.2」、引用されたテキスト、「The command and control unit shall …」、「ASME Boiler and Pressure Vessel Code」、「5 Nm at 3000 rpm and 24 V」、「including batteries and strap」、「either open or closed」 | 何もしません。 |
1 つの量の 2 つの値(「at -20 °C and 60 °C」)には注記が付きます。「, and」は条件の終わりを示します:「… when the level falls below 10 %, and restart when …」は指摘になります。1 つとして動作する主語(「The Owner and the Contractor shall agree …」「The power and data connector shall …」)には注記が付きません。それぞれが動作する 2 つの主語(「The pump and the valve shall close …」)には注記が付きます。比較表現(「12 or more」)は指摘されません。動作の後に来る名前は 2 つの値と区別できないため、複合名に登録します。
複合名。品質ページでその他 ▾ → 複合名…を選ぶと、「and」や「or」を含むが 1 つの物を指す名前のプロジェクトの一覧が開きます。1 行に 1 つずつ書きます(たとえば「power and data connector」)。R19 はこれらを指摘しません。プロジェクトの略語集にある展開形(Acronym ステートメント、略語を見つけるを参照)も対象になり、よく使われるいくつかの名前は組み込まれています(「command and control」「research and development」「operations and maintenance」…)。一覧はプロジェクトとともに保存され、元に戻せます。変更を適用するには、もう一度品質をチェックをクリックします。
他の言語の要求
Holarch は各要求の言語をテキストから検出します。語のルール(R2–R10、R16、R19、R20、R24、R26、R31–R35、「up to」、助動詞、単位)は英語の要求を採点します。
ドイツ語、フランス語、スペイン語(ベータ)。これらの要求には、それぞれの言語で同じルールが適用されます。たとえばドイツ語の「angemessen」や「bei Bedarf」、フランス語の「approprié」や「si possible」、スペイン語の「adecuado」や「según corresponda」です。ある言語のルールがベータの間は:
- 各指摘は (ベータ)と表示された提案です。他の注記とともに灰色で表示され、基準やスコアを下げることはありません。
- 注記「この言語の表現ルールはベータです。提案のみで、スコアには含まれません。構造チェックは適用されます。」が表示され、記述が AI でチェックされるか手動で評価されるまで、Unambiguous は –(チェックなし)になります。
- 「each」に当たる語(jede、chaque、cada)は正しい選択なので指摘されません。「alle 5 s」や「tous les 5 s」(5 s ごと)も指摘されません。
ある言語でルールがスコアに数えられるのは、その言語で書かれた 300 件以上の文で測定され、母語話者の要求エンジニアがレビューし(指摘の 90 % 以上が正しい)、そのレビュー担当者がサインオフした後だけです。そうなると、その言語のスコアは次回のチェックで変わることがあり、リリースノートにその旨が記載されます。
その他の言語(日本語、イタリア語、中国語など)には次のものが適用されます:
- 注記「表現ルールは英語を対象としています。構造チェックは適用されます。」と、Unambiguous の –(チェックなし)。記述がチェックされるか手動で評価されるまで、スコアから除外されます。TBD など Unambiguous の別の指摘があれば、引き続き不合格になります。
- すべての言語に共通のチェック:R18(。も含む)、末尾のピリオド(。も含む)、R17、R21、TBD/TBR、R30、名前、説明、検証リンク。
ベータかどうかにかかわらず、すべての言語にこれらのチェックも適用されます。提案は、語を書かれたとおりに引用した形で英語で保存されます(「R7 - Imprecise wording: [angemessen] (beta)」)。そのため、quality:R7 フィルターとエクスポートはどの言語でも同じように機能します。公開 API は、ルール、語、モード(findings)とともにこれらを返します。
AI で記述をチェック。品質ページの ✦ AI ▾ → AI で記述をチェック…(または 1 つの要求の ✦ More AI ▸)は、設定された AI を通じて、各要求の言語で同じルールを適用します。プレビューには、指摘と、その言語での任意の書き直し(チェックなし)が一覧表示されます。選択した項目を適用は、指摘を AI の指摘として追加し、注記を除去します(ベータの提案は注記として残ります)。これは 1 回の元に戻す操作です。テキストを編集するとクリアされます。AI 付きのプランが必要です。
手動の上書き
自動の結果に同意できない場合や、レビュー担当者の判断を記録する場合に、基準を上書きします。
- 品質ページ:基準のセルをクリックすると切り替わります。1 回目のクリックで手動の「はい」(✔)、次に手動の「いいえ」(✘)、3 回目で手動の値がクリアされ、自動チェックが再び判定します。手動のセルには手動の印が付きます。ツールチップには「(手動で設定)」と、次のクリックで何が起こるかが表示されます。
- インスペクターまたは項目ビュー:各基準ははいといいえのリストです。手動で設定した基準には自動(再チェック)もあり、自動の結果に戻します。手動で設定した値には「manual」と表示されます。
手動の値は、チェックを再実行しても保持されます。他のメッセージがない手動の「いいえ」には「Marked No manually.」と表示されます。
上書きは次の 2 つの場合にクリアされます。
- 要求の名前または説明が変更されたとき。上書きは履歴に残り、元に戻すで復元されます。
- その他 ▾ → 手動評価をクリアを選んだとき。受け入れた AI の指摘もクリアされます。
古い結果
チェック後に要求の名前または説明が変更されると、その結果は古い状態になります。
- 品質ページに「古い結果 — 再実行」と表示され、ツールチップに「前回のチェック後にテキストが変更されました。もう一度品質をチェックしてください。」と表示されます。
- ドキュメントの品質スコア列には、時計アイコン付きの古いタグが表示されます(ポインターを合わせると理由が表示されます)。
- インスペクターには「Quality: stale — re-run」と表示されます。
古い結果を避けるには、テキストが変更されたら自動的に再チェックをオンにします。編集した要求に対してすぐにルールチェックが再実行されます。この設定はこのブラウザーに保存されます。
ドキュメントから品質をチェックする
ドキュメントではチェック ▾ → 品質をチェックを選択します。要求を選択している場合、項目はこの要求の品質をチェックとなり、その要求をチェックします。要求を選択していない場合は、ドキュメント内の表示中のすべての要求をチェックします。
結果は品質をチェック — <name>ダイアログに、タイルと表とともに表示されます。ボタンは CSV をエクスポート、XLSX をエクスポート、品質で開く、閉じるです。
要求のないドキュメントでは「This document has no Requirements to check. Statements are not scored.」と表示されます。
AI 要求チェック
ルールでは判定できない基準(Correct、Feasible、Necessary)について最初の意見を得るには、AI 要求チェックを使います。ルールが見落とす表現も、Unambiguous(たとえば、下限の意味と思われる「up to 72 hours」や、尺度のない「accurately」)と Verifiable(書かれたとおりでは、テスト、解析、検査、実演のいずれでも要求が満たされたことを示せない)で探します。AI はルールの指摘を受け取り、それらが見落としたものだけを報告します。
- ✦ AI ▾ → AI でチェック(N 件の要求)…を選択します。
1 つの要求の場合は、その ✦ AI ▾ メニューで AI でチェック(この要求)…を、または右クリックメニューで ✦ More AI ▸ → ✦ AI でチェック…を選択します。
Claude が要求をレビューします。要求は 20 件ずつのグループで送信され、重複チェック用に最大 300 件の他の要求も送られます。付属の AI では、チェックは要求 100 件につき 1 リクエスト(切り上げ)として数えられます。100 件を超える要求のチェックを実行する前に、使用するリクエスト数がダイアログに表示されます。たとえば「このレビューでは、今月残っている付属の AI リクエスト 52 件のうち 3 件を使用します(要求 100 件につき 1 リクエスト)。」です。残りより多くのリクエストが必要なチェックは開始されません。
- ダイアログで各要求をレビューします。
上部の行には、最初にチェックが入っているものが示されます:「チェックした項目が適用されます。書き直しは先に読めるよう、最初はチェックされていません。ロック済み、承認済み、ベースライン化済みの要求も最初はチェックされていません。」
- 受け入れる変更と書き直しにチェックを入れます。
ボタンの上の行には、適用で行われる内容の件数が表示されます。たとえば「Applies 7 values and 2 rewrites to 5 requirements.」です。何もチェックしていない場合は「何も選択されていません。」と表示され、選択した項目を適用は淡色表示になります。
- 選択した項目を適用をクリックします。
チェックした項目が適用されます。1 回の元に戻すですべて取り消せます。トーストに「Applied N AI changes」と表示されます。
ダイアログには、要求ごとに次の内容が表示されます。
- Correct、Feasible、Necessary、Unambiguous、Verifiable の Yes/No の判定と理由。
- 各判定の下に、適用すると何が変わるかをラベルにしたチェックボックス。保存されている値がすでに一致している場合は、チェックボックスなしで「変更なし」と表示されます。
- Correct、Feasible、Necessary:判定が保存されている値と異なる場合は「No → Yes」または「Yes → No」、値がない場合は「Set to Yes」または「Set to No」。
- Unambiguous と Verifiable:AI が問題を見つけた場合は「指摘事項を追加」、以前の AI の指摘が当てはまらなくなった場合は「以前の指摘事項をクリア」。
- 任意のコメント。
- AI が提案した場合は、単語単位の差分付きの書き直しを適用:チェックボックス。
最初にチェックが入っているもの:
- すべての値の変更は、最初からチェックが入っています。
- 書き直しは、先に読めるよう最初はチェックされていません。
- 承認済み、ベースライン化済み、ロック済みの要求は、最初はチェックされておらず、印が付きます。
書き直しにチェックを入れると、その要求の Unambiguous と Verifiable のボックスが淡色表示になり、「書き直し後に再チェック済み」というラベルが付きます。新しいテキストでルールチェックが再実行されます。書き直しのチェックを外すと、ボックスは元に戻ります。Correct、Feasible、Necessary は引き続き適用されます。
| ボタン | 効果 |
|---|---|
| すべての値の変更を選択 | 承認済み、ベースライン化済み、ロック済みの要求を除き、すべての値の変更にチェックを入れます。 |
| すべての書き直しを選択 | 印の付いたものを除き、すべての書き直しにチェックを入れます。 |
| 選択を解除 | すべてのチェックを外します。 |
適用で行われること:
- Correct、Feasible、Necessary は手動の Yes/No の値になります。
- Unambiguous または Verifiable の「いいえ」は AI の指摘になります。品質ページでは、ルールの指摘とともに「AI: ambiguous — <reason>」または「AI: not verifiable as written — <reason>」として一覧表示され、基準には ✘ が表示されます。「はい」は以前の AI の指摘を除去します。
- AI の指摘は、要求の名前または説明が変更されたとき(受け入れた書き直しによる変更も含む)と、その他 ▾ → 手動評価をクリアでクリアされます。
選択した項目を適用で行われること:
- 判定は、メッセージ「AI: <reason>」付きの手動の値になります。チェックを再実行しても保持されます。
- 書き直しは説明を置き換え、チェックを再実行します。
品質のエクスポート
| エクスポート | 内容 |
|---|---|
エクスポート ▾ → CSV(quality_report.csv) | 要求と基準の組ごとに 1 行:Number、Name、Description、Quality Score、Attribute、Message、Result。 |
エクスポート ▾ → Excel(.xlsx)(quality_report.xlsx) | Number、Name、Description、Rationale、Quality Score、Attribute、Message、Result。要求のセルは 9 行にわたって結合され、Yes は緑、No は赤で表示され、最後にレポートのスコア(全回答に占める Yes の割合)が付きます。 |
| ドキュメントの納品 ▾ → すべてのエクスポート… → Quality findings (Excel) | 1 つのドキュメントについて同じレイアウトで、ドキュメントの表示列が付きます。 |
承認
ニーズと要求 → 承認を使って、決定待ちのものをすべて確認します。クエリ Requirement:"Status=In Review" でデータベースが開きます。
データベースのすべての機能があります。
- 複数の行を選択し、一括バーで Status やラベルをまとめて設定。
- 一覧のエクスポート。
- 行をダブルクリックして、項目ビューと完全な履歴を表示。
承認ボックス
承認ボックスは、すべての要求のインスペクターと項目ビューに表示されます。次の内容が表示されます。
- 現在のステータスを示す色付きのチップ(未設定の場合は Draft)。
- 最後に記録された決定:「<status> by <name> · <date and time>」。注記がある場合はその後に「— <note>」(たとえば「— 承認後にテキストが変更されました」)、決定がない場合は「承認の記録はありません」。
- 現在のステータスに当てはまるボタン:
| ボタン | 表示される条件 | 効果 |
|---|---|---|
| 承認 | Status が Approved でも Rejected でもない | Approved に設定し、あなたと時刻を記録します。トースト:「承認しました」。 |
| 却下… | Status が Approved でも Rejected でもない | 要求を却下ダイアログで理由(任意)を尋ね、Rejected に設定します。トースト:「却下しました」。 |
| 再オープン | Status が Approved または Rejected | In Review に設定します。トースト:「レビュー中に移動しました」。 |
記録される名前はアカウント名です。表やインスペクターで Status を手動で設定した場合も、あなたの名前と時刻とともに決定が記録されます。閲覧者にはボタンなしのボックスが表示されます。
ワークフローによって Approved への移行が変更要求を経由する場合、ボックスには代わりに未解決の要求とその件数が表示されます。たとえば CR-4: 1 of 3 approvals です。適用されると、決定にはすべての承認者と要求の名前が記録されます:「Approved by Ann Lead, Bob Discipline · <date and time> · CR-4」。
注:Approved の要求の名前または説明を編集すると、「承認後にテキストが変更されました」という注記とともに In Review に設定されます。トーストには「承認済みの要求 N 件をレビュー中に移動しました」と表示されます。他の属性を変更しても再オープンされません。
TBD/TBR 登録簿
登録簿を使って、すべての未解決項目を解決まで追跡します。ニーズと要求 → TBD/TBR を開きます。ドキュメントからはチェック ▾ → TBD/TBR 登録簿を選ぶと、そのドキュメントに範囲を絞った登録簿が開きます。
- ページヘッダー:XLSX をエクスポート(登録簿が空のときは無効)。
- 範囲バー:Scope(すべての要求またはドキュメント: <name>)。
- タイル:未解決の TBD/TBR、Overdue、オーナーなし、各ドキュメントを開くドキュメント別のチップ(「<document>: <count>」)。
- 未解決項目の推移:未解決件数のバーンダウン。要求の履歴から作り直され、最も古い要求から現在まで最大 60 点で表示されます。点にポインターを合わせると日付と件数が表示されます。履歴が少なすぎる場合は「バーンダウンに必要な履歴がまだありません。」と表示されます。
- 表の列:
- Number、説明付きの名前。
- ドキュメント。
- 種類:TBD、TBR、TBS と、「attribute」「in text」またはその両方。
- Owner:TBD Owner、なければ要求の Owner、それもなければ「—」。
- 期限:要求の唯一の期限で、インスペクターのワークフローグループと項目ビューの期限と同じ日付です。TBD Due Date 属性に日付があればその値、なければ要求の期限です。過去の日付の下には「Overdue」と表示されます。期限切れの行は色付きになります。
- Age:項目が開かれてからの日数。
- 閉じる。
行を右クリックするか、行で Shift+F10 を押すと、データベースと同じ行メニューが開きます:理由付きのおすすめの操作、✦ More AI ▸、Open、名前を変更…、複製、子を追加…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、リンクをコピー、Copy Number、削除…。他の右クリックメニューでは、未解決の TBD または TBR がある要求のメニューは Resolve TBD… で始まり、その要求を選択した状態でこの登録簿を開きます。
登録簿は読み取り専用です。期限を変更するには、行を選択してインスペクターで期限を設定します。要求の期限と、TBD Due Date 属性に日付がある場合はその属性も(時刻を保ったまま)設定されます。1 回の元に戻すですべて取り消せます。期限をクリアすると両方がクリアされます。
閉じるは TBD/TBR 属性が設定されているときだけ表示されます。属性を None に設定します。
- テキストに何も残っていない場合、トーストに「完了」と表示されます。
- テキストにまだ TBD、TBR、TBS がある場合、トーストに「属性を閉じました。テキストにはまだ TBD が含まれています。」と表示されます。
- テキストだけの項目には閉じるボタンがありません。テキストを編集して解決します。
未解決のものがない場合、ページには「未解決の TBD/TBR 項目はありません。ここに表示するには、要求の TBD/TBR 属性を設定するか、テキストに TBD、TBR、TBS と書きます。」と表示されます。
XLSX をエクスポートは TBD-TBR Register.xlsx を書き出します。列は Number、Name、Document、Type、Source(attribute、text、both)、Owner、Due Date、Opened、Age (days)、Overdue(Yes は赤)、Description です。
確認が必要なリンク
確認するリンク(他のツールではサスペクトリンクとも呼ばれます)を使って、要求の変更後に再チェックが必要なものを見つけます。リンクの前回のレビュー後に反対側の項目が変更されると、そのリンクはレビューが必要になります。リンクがまだ有効か確認してから、レビュー済みにします。ニーズと要求 → 確認するリンクに一覧表示されます。ドキュメントからはチェック ▾ → 確認するリンクを使います。
リンクがレビュー対象になる条件
要求に対する次の変更で、そのリンクがレビュー対象になります。
- 名前または説明。
- 優先度、Criticality、Verification Method、検証レベル。
- 数値、パーセント、期間の任意の属性。
その後、要求の次の種類のリンクがそれぞれレビュー対象になります:decomposed by、derived by、refined by、satisfied by、verified by、traced to。
Verification Method または検証レベルの変更でレビュー対象になるのは、verified by リンクだけです。要求に最初の方法やレベルを設定しても、何もレビュー対象になりません。検証を計画するだけで、レビュー済みのものは何も変わらないためです。
各リンクの反対側がレビュー対象の項目です:子要求、満たす機能やアセット、検証するテストケースなど。同じ要求がさらに変更されると、同じ印の変更フィールドの一覧に追加されます。
確認が必要なリンクが表示される場所
- 確認するリンクページ:レビューが必要なリンクごとに 1 行。
- ドキュメントとデータベース:項目の行に ⚠ レビューバッジ(「The item at the other end changed after this link was last reviewed. Check that the link still holds, then mark it reviewed. Click to review.」)。
- インスペクターと項目ビュー:バナー「⚠ レビュー: このリンクの前回のレビュー後に <requirement> が変更されました。リンクがまだ有効か確認してから、レビュー済みにしてください。」。そのレビュー…ボタンを押すと、その項目のレビューするリンク — <item>ダイアログが開きます。ダイアログにはレビュー待ちのリンクと閉じるがあります。
- インスペクターのトレースセクション:レビューが必要な各リンクの横に ⚠。ツールチップに変更されたフィールドと日付が表示されます。
- RVTM:どちらかの端にレビューが必要なリンクがある要求(その要求が変更されたか、上流の項目が変更された)の後に ⚠。クリックするとそれらのリンクをレビューできます。検証元のテストケースの後の ⚠ は、その検証リンクを示します。
確認が必要なリンクのページ
ページの上部にルールの説明があり、表が表示されます。
| 列 | 内容 |
|---|---|
| (チェックボックス) | 選択したものをレビュー済みにする…の対象として選択します。見出しのチェックボックスですべて選択します。 |
| 変更 | 変更された要求。 |
| 変更 | 変更されたフィールド。たとえば「Description」や「Priority, Verification Level」。 |
| 日時 / 担当者 | 変更の日時と、変更した人。 |
| 関係 | 変更された要求から見たリンクの種類(たとえば「satisfied by」)。 |
| レビュー対象の項目 | リンクの反対側にある項目。 |
| (操作) | 差分とレビュー済みにする…。 |
行を右クリックするか、行で Shift+F10 を押すと、データベースと同じ項目の行メニューが開きます:おすすめの操作、✦ More AI ▸、Open、名前を変更…、複製、子を追加…、Status ▸、Priority ▸、Relate To ▸、Add to Document ▸、Show in Diagram ▸、リンクをコピー、Copy Number、削除…。他の右クリックメニュー(データベース、ドキュメント)では、レビューが必要なリンクを持つ項目のメニューはリンクを確認…で始まり、その項目のレビューを開きます。
差分は、名前と説明の単語単位の差分を示す変更 — <requirement>を開きます。属性だけが変更された場合は「変更されたのは属性のみです: <fields>。詳細は項目の履歴を開いてください。」と表示されます。履歴…は要求の履歴を開きます。
リンクをレビュー済みにするには:
- 行のレビュー済みにする…、チェックした行に対する選択したものをレビュー済みにする…、またはMark All Reviewed (N)…をクリックします。
Mark N Link(s) Reviewed が開きます:「変更後もリンクされた項目が有効であることを確認してください。リンクされた各項目にコメントが追加されます。」
- 必要に応じてコメントを入力します。たとえば「Child still valid; no change needed.」。
- レビュー済みにするをクリックします。
トーストに「N 件のリンクをレビュー済みにしました。」と表示されます。
何も選択せずに選択したものをレビュー済みにする…を押すと、「先にレビュー済みにするリンクを選択してください。」と表示されます。
リンクをレビュー済みにすると、レビューがリンクに記録されます:誰が、いつ、コメント、フィールド。コメントを書いた場合は、各項目のコメントにも「Link reviewed (<requirement> changed: <fields>): <comment>」が追加されます。元に戻すで取り消せます。
レビューが必要なリンクがない場合、ページには「レビューするリンクはありません。リンクの前回のレビュー後に反対側の項目が変更されると、そのリンクはレビューが必要になります。」と表示されます。
ベースラインとバージョンの比較
ドキュメントのベースライン
ドキュメントのベースラインは、ドキュメントの表題欄にあるバージョン ▾で作成・使用します。次のものが一覧表示されます。
- 現在のバージョン:現在のドキュメント。
- このドキュメントの各ベースライン(新しい順、日付付き)。
- プロジェクトのベースラインの下に、すべてのプロジェクトのベースライン。
- ベースラインを保存…と版を比較…(ドキュメントにベースラインができるまで淡色表示:「先にベースラインを保存してください」)。
ベースラインを保存…を選ぶとベースラインを保存が開きます。
- 名前 *(必須)。
- 承認:Name、Role、Statement の行と + 承認者を追加。最初の行にはあなたの名前が入っています。空の場合は「承認者がいません。」。
- 注記「The baseline keeps this version of the document (its items, their attributes and relationships) to view, compare and restore later. Approval records are dated now and cannot be edited afterwards.」(ベースラインは、後で表示、比較、復元できるよう、このバージョンのドキュメント(項目、その属性と関係)を保持します。承認記録には現在の日付が付き、後から編集できません。)
バージョン ▾でベースラインを選ぶと表示されます。ドキュメントは読み取り専用になり、バナー「Baseline “<name>”, read-only, saved <date>」と承認の一覧が表示されます。次のボタンが表示されます。
| ボタン | 効果 |
|---|---|
| 現在に戻る | 現在のドキュメントに戻ります。 |
| 編集 | ベースラインを編集:名前を変更し、承認記録を追加します。承認(ロック済み)には既存の記録が一覧表示され、変更できません。新しい記録は「are dated now and added to the list」(現在の日付で一覧に追加されます)。ドキュメントのベースラインのみ。 |
| 現在と比較 | このベースラインからバージョンを比較を開きます。ドキュメントのベースラインのみ。 |
| ベースラインを復元 | ドキュメントのベースライン:「Overwrite this document's entities, order and structure with baseline "<name>"? Entities added since are removed from the document (not deleted). Undo is available.」(このドキュメントのエンティティ、順序、構造をベースラインで上書きしますか。その後に追加されたエンティティはドキュメントから除去されます(削除はされません)。元に戻せます。)プロジェクトのベースライン:プロジェクトをベースラインで置き換え、「Replace the entire project with project baseline "<name>"? Undo is available.」(プロジェクト全体をプロジェクトのベースラインで置き換えますか。元に戻せます。) |
| 削除 | 「Delete baseline "<name>"?」(ベースラインを削除しますか。) |
現在のドキュメントでは、各行に変更バーが付きます:ベースライン以降に新規、ベースライン以降に変更、または変更なし。比較対象は最新のドキュメントのベースラインで、ドキュメントにベースラインがない場合は最新のプロジェクトのベースラインです。
バージョンを比較する
変更レポートを使って、レビュー以降に何が変わったかを正確に確認します。
- バージョン ▾ → 版を比較…、またはベースラインのバナーの現在と比較をクリックします。
バージョンを比較が開きます。
- From を選択します:ベースライン。
- To を選択します:それより後のベースライン、または現在のバージョン。
表には Number、名前、種類を変更、フィールド、変更(変更されたテキストの単語単位の差分)が一覧表示されます。
変更の種類:
| 変更の種類 | 意味 |
|---|---|
| Added / Removed | エンティティがドキュメントに加わった、またはドキュメントから外れた。 |
| Modified | フィールドが変更された:Name、Number、Description、Class、Image、または任意の属性(フィールド名が示されます)。 |
| Label Added / Label Removed | ラベルが追加または除去された。 |
| Relationship Added / Relationship Removed | ドキュメントに接するリンクが追加または除去された。 |
| Relationship Attribute | 関係の属性が変更された。 |
変更(Excel)は「<document> (Changes).xlsx」を書き出します。列は Number、Name、Class、Change Type、Field、Old Value、New Value です。変更履歴版(Word)は同じ比較を Word の変更履歴として書き出します。
ドキュメントの納品 ▾ → 変更(Excel)…(すべてのエクスポート…にもあります)は、From と To を指定して同じレポートをエクスポートします。ベースラインがない場合は「This document has no baseline. Save one first.」で失敗します。
Document (Word) は、Word 出力の Revision History と Approvals の表をドキュメントのベースラインから埋めます。
ベースラインとバージョンのページ
管理とレビュー → ベースラインとバージョンを使って、プロジェクト内のすべてのベースラインを管理します。プロジェクトのベースラインはすべてのエンティティを保持し、ドキュメントのベースラインは 1 つのドキュメントを保持し、ドキュメントのバージョン ▾ → ベースラインを保存…で作成します。ページヘッダーには、プロジェクト全体の以前の自動保存を戻す以前のバージョンを復元…と、+ ベースラインを保存…があります。
プロジェクトのベースラインを作成するには:
- ページヘッダーの+ ベースラインを保存…をクリックします。
プロジェクトのベースラインを保存ダイアログに、現在のエンティティと関係の件数が表示されます。名前の既定値は「Baseline <n>」で、プレースホルダーは「Name, for example "SRR"」です。
- 名前を入力し、Enter を押すかベースラインを保存をクリックします。空の名前は拒否されます(「名前を入力してください。」)。
トーストに「ベースラインを保存しました」と表示されます。
ページのカード:
- ベースラインカード:現在の件数(「Current: <n> items, <n> relationships」)とフィルター(すべてのベースライン、プロジェクト全体のベースライン、ドキュメント: <name>)。列:
- 名前。
- ドキュメント:そのベースライン時点のドキュメントを表示するリンク、または「Project」。
- Created。
- 承認:「✔」と承認者の名前。ポインターを合わせると役割、日付、記述が表示されます。「by <name>」は作成者を示します。
- Entities と関係。
- 比較:このベースラインを From に、現在の作業コピーを To に設定します。
- ⋯(その他の操作):
- 名前を変更…:ベースラインの名前を変更。
- エクスポート(JSON):「<name>.json」をダウンロードします(形式
holarch-baseline、スナップショットと承認を含む)。 - ベースラインを復元…(プロジェクトのベースライン):「Replace all current entities and relationships with baseline "<name>"? Undo is available (⌘Z / Ctrl+Z).」(現在のすべてのエンティティと関係をベースラインで置き換えますか。元に戻せます(⌘Z / Ctrl+Z)。)トースト:「Restored "<name>"」。
- ドキュメントを元に戻す…(ドキュメントのベースライン):「Restore document "<doc>" to baseline "<name>"? Only that document's entities and structure change. Undo is available.」(ドキュメントをベースラインに復元しますか。変更されるのはそのドキュメントのエンティティと構造だけです。元に戻せます。)ドキュメントが削除されている場合は無効です。
- 削除…。ホスト型サービスでは、ベースラインの名前の変更や削除ができるのはプロジェクトのオーナーだけです。他のユーザーにはこれらの項目が理由とともに淡色表示されます。
- 孤立したベースライン(必要なときに表示):「N baselines of deleted documents」。それぞれに、ベースラインからドキュメントのアーティファクトとそのエンティティを作り直すドキュメントを復元と、削除があります。
- 比較カード:比較元 (古い)と比較先 (新しい)を選択します。比較先は現在のバージョンか、同じ範囲の別のベースラインです。
- タイル:Entities added、Entities removed、Entities changed、Relationship changes。
- 表には Entity、変更、フィールド、Difference(単語単位の差分)が表示されます。日付の属性はアプリの日付形式で表示されます。
- CSV をエクスポートと XLSX をエクスポートは「Changes <from> to <to>」を書き出します。
- 表示するものがない場合:「No differences between “<from>” and “<to>”.」
ベースラインがない場合:「No baselines. Create one to record the current state of the project.」
注:ベースラインはプロジェクト内に保存され、プロジェクトのエクスポートに含まれて一緒に移動します。プロジェクトのベースラインはエンティティと関係を保持します。ドキュメントのベースラインは、ドキュメントのアウトライン設定も保持します。
要求をインポートする
ニーズと要求 → インポートとエクスポートを使って、ファイルから要求を取り込みます。4 つのステップで進みます:ファイル → マッピング → 確認 → インポート。
- Back と続行でステップ間を移動します。確認ステップの Import N items で、インポートします。1 回の元に戻すですべて取り消せます。
- 1 つのドロップゾーンですべての形式を受け付けます。形式はファイル(名前と、それで足りない場合は内容)から検出されて形式に表示され、そこで変更できます。
形式は Word (.docx)、Holarch プロジェクトファイル(.holarch, .json)、Excel / CSV (.xlsx, .csv)、Plain Text (.txt)、UML/SysML (.xmi, .uml, .mdzip)、ReqIF(.reqif)です。
このセクションでは要求の形式を扱います。プロジェクトファイル、XMI、その他すべてのインポートとエクスポートについては、インポートとエクスポートを参照してください。
ステップ 1:ファイル
「Drop a file here or click to choose one」にファイルをドロップするか、ボックスにテキストを貼り付けてテキストを解析をクリックします(見出し行付きの CSV、ReqIF XML、XMI、JSON、ドキュメントのテキスト)。
| オプション | 値 | 効果 |
|---|---|---|
| 形式 | 上記の 6 つの形式 | 検出された形式を表示します。別の形式を選ぶと、同じ内容を別の方法で読み取ります。 |
| テキストのエンコード(CSV、テキスト) | Automatic、UTF-8、ISO-8859-1 / Windows-1252、Shift_JIS、Big5、UTF-16 | ファイルのバイトの読み取り方。変更するとファイルを読み直します。 |
| シート(ブック) | 「<name> (N rows)」 | インポートするシート。データのある最初のシートがあらかじめ選択されています。 |
- プレーンテキスト:ボックス内のインポートした内容は編集できます。編集して解析を再実行をクリックします。
- ステータス行には「Analyzed “<file>”: N rows, M columns.」と表示されます(さらに「(sheet “<name>”)」と、Word の場合は「, N table(s)」)。
ステップ 2:マッピング
ファイルの各列が 1 行になります:ファイルの列(タイトルと位置)、値の例(最初の 3 行)、Holarch のフィールド。列を除外するにはスキップを選択します。列のタイトルから一致したフィールドには自動と表示されます。
| Holarch のフィールド | 内容 |
|---|---|
| 名前、Number、説明 | 項目自体のフィールド。 |
| クラス、ラベル | クラス名。ラベル名は ; 、, 、| のいずれかで区切ります。 |
| 親番号、グローバル ID | 親の番号。既存のエンティティとの照合に使う ID。 |
| 属性 | クラスのない行のクラスの任意の属性。 |
| 関係 | 複数のターゲットは ; で区切ります。 |
| 行 ID、親行の ID、新しい属性(スキーマに追加) | ReqIF と XMI ファイルの構造、および新しい属性。 |
✦ AI ▾ → マッピングを提案は、列ごとにフィールドを提案します。提案されたマッピングには、変更がチェック付きで AI の理由とともに一覧表示されます。チェックした項目を適用でマッピングが変わります。この時点ではまだ何もインポートされません。
Holarch は見出しからマッピングを推測します。
| 見出し | マッピング先 |
|---|---|
| Number, No, Num, #, ID Number, Req Number, Requirement Number | 番号 |
| Name, Title, Short Name, Requirement Name | 名前 |
| Description, Text, Requirement, Requirement Text, Statement, Desc | 説明 |
| Class, Type, Entity Class | 分類 |
| Labels, Label, Tags | Labels(値は ; 、, 、| のいずれかで区切る) |
| Parent, Parent Number | Parent number |
| Global ID, ID, GUID, UUID | Global ID |
| 属性名(たとえば Priority、Rationale、Status) | その属性。「Method」と「Verification」は Verification Method にマッピングされます。 |
| ラベルグループ名(たとえば、そのような属性がない場合の Verification Method) | ラベル |
| 関係名(たとえば satisfied by) | その関係。複数のターゲットは ; で区切ります |
| Object Identifier, Origin ID | Global ID |
| Object Number, ReqIF.ChapterName, ReqIF.ForeignID | 番号 |
| Object Heading, ReqIF.Name, Long Name | 名前 |
| Object Text, ReqIF.Text, ReqIF.Description | 説明 |
| ReqIF.Category | 分類 |
| ReqIF ID, XMI ID, Row ID / Parent ID | Row ID / Parent row ID |
新しい属性は、インポートする各クラスに列名の属性を作成します。型は値に従います。
- すべての値が数値の場合は数値。
- 短い異なる値が少数の場合は選択リスト。
- 120 文字を超える値の場合は長いテキスト。
- それ以外はテキスト。
品質基準、計算属性、ファイル属性はマッピングできません。
列の下:
| オプション | 値 | 効果 |
|---|---|---|
| クラスのない行のクラス | 任意のクラス。既定は Requirement | Class 列に値がなく、一致するクラスルールもない行のクラス。 |
| クラスルール | 説明に含む語または語句 → クラス | + ルールで追加し、× で除去します。Class の値がない行には、最初に一致したルールが適用されます。 |
| Match existing entities by | Global ID、Name、Number | 既存のエンティティに一致する行は、コピーを作らずにそのエンティティを更新します。Name と Number で照合する場合は、同じクラスであることも必要です。 |
| Match related entities by | Global ID、Name、Number | 関係の列の値がターゲットを見つける方法。 |
| 日付列の日付形式(CSV) | Automatic、yyyy-MM-dd HH:mm:ss、dd/MM/yyyy、MM/dd/yyyy、yyyyMMdd、Custom… | 日付セルの読み取り方。カスタム…を選ぶと、yyyy、MM、dd、HH、mm、ss を使った独自のパターン(たとえば dd.MM.yyyy HH:mm)を入力するフィールドが表示されます。 |
| 番号付けのパターン(Word、テキスト) | 空(自動)、1. a) (i) のような記号、または 1.1 や 1.1.a のようなパス番号 | 番号付きの段落がアウトラインになる方法。テキストの場合、パターンは番号付けから検出されて入力されます。Word の見出しスタイルとリストの番号付けにはパターンは不要です。番号付けのパターンを参照してください。 |
| 子を親の下で番号付け(1 → 1.1)(Word、テキスト) | 既定でオン | 生成される子の番号は「1」「2」ではなく「3.1」「3.2」になります。 |
階層。アウトライン番号から階層が作り直されます:「1.2.3」は「1.2」の子になります。親番号列、または行 IDと親行の IDの組で、親を明示的に設定します。親のない項目はドキュメントの最上位の項目になります。
Word の表。Word ファイルの場合、Word の表セクションに各表が一覧表示されます。セクションをまたいで同じ見出しで繰り返される表は、1 つのマッピングを共有します。セクションには次の説明があります:「Import a requirements table as entities, one per row, and map its columns. Other tables stay as tables in the description of the item they follow.」(要求の表を 1 行につき 1 エンティティとしてインポートし、列をマッピングします。他の表は、直前の項目の説明内に表として残ります。)
- 各表を Entities (one per row) または説明内の表に設定します。
- 列を Number、Name、Description、Class、Labels、Attribute、New attribute、Skip にマッピングします。
- ID、Req ID、Requirement ID、Ref、Paragraph などの見出しは Number にマッピングされます。
- Shall、Shall Statement、Requirement Statement、Requirement Text、Statement、Text は Description にマッピングされます。
番号または説明の列と「shall」を含む行がある表は、最初はエンティティとして扱われます。
これまでに見つかった警告が列の下に表示されます。ない場合は「警告はありません。」。
ステップ 3:確認
何かが変わる前に結果を確認します。確認ステップでは、ベースラインとバージョンでバージョンを比較するのと同じ方法で変更が表示されます(ベースラインとバージョンの比較を参照)。
- 1 行目に、ファイル、形式、クラスごとの項目数が示されます。
- すべての項目が Statement または Requirement(またはそのサブクラス)の場合、Create a requirements document from these N requirements がチェック付きで表示されます。他のファイルではCreate a document from these N items となり、チェックは入っていません。チェックを入れたら、ドキュメントの種類(既定は Requirements Document)、名前(既定はファイル名)、インポート後にドキュメント全体の番号を振り直すかどうかを選択します。
- 続いて警告が表示されます。
- タイルには、新しい項目、更新された項目、照合済み、変更なしの項目、ファイルからの関係の件数が表示されます。
- 変更の表には、新しい項目ごとにその説明が、更新された項目の変更されたフィールドごとに古い値と新しい値の単語単位の差分が一覧表示されます(最初の 500 件の変更)。
Import N items をクリックします。トーストに「Imported N new, M updated」と表示されます。
- 警告がなければ、新しい要求ドキュメント(またはデータベース)が開きます。
- それ以外の場合は、インポート完了カードに警告が一覧表示されます(問題がない場合は「The import reported no warnings.」)。ボタンはドキュメントを開く、データベースを開く、Spider 図、ツリー図、品質をチェック、別のインポートを開始です。
新しいドキュメントの説明には、インポートの警告が一覧表示されます。
各形式の読み取り方
Word(.docx):
- 見出しと Word のリストの番号付けがアウトラインになり、番号が保たれます。
- 見出しは Statement になります。その下の本文はその説明になります。
- shall、must、will、should を含む段落は子の Requirement になり、助動詞の後の語から名前が付きます。番号付きのリスト項目も同様です。助動詞がない場合は Statement になります。
- 箇条書きの項目、画像、表は、直前の項目の説明に加わり、太字、斜体、リスト、表が保たれます。
- 元の .docx は、ファイルごとの添付ファイル上限内であれば新しいドキュメントに添付されます。
- PNG、JPEG、GIF、WebP、SVG の画像は保持されます。その他の画像形式は警告とともにスキップされます。
Excel(.xlsx、.xlsm)と CSV:
- 1 行につき 1 エンティティ、列は任意。最初の行が見出しです。
- 複数行のセルは改行が保たれます。
- Excel 97-2003(.xls)ファイルは読み取れません。先に .xlsx または .csv で保存してください。
ReqIF(.reqif、.reqifz):
- 各 SPEC-OBJECT は、ReqIF ID、Parent ID(仕様の階層から)、種類(オブジェクトの型。Class にマッピング)、Long Name、属性定義ごとに 1 列を持つ行になります。
- 一致しない列の既定は新しい属性です。XHTML 属性はリッチテキスト属性に、列挙属性は選択リストになります。
- SPEC-RELATION は名前によって関係になります。名前がスキーマで許可されている関係と一致しない場合は traced to になります。
- .reqifz アーカイブは自動的に展開されます。
プレーンテキスト(.txt)または貼り付けたテキスト:
- 番号付きの行(「3.1 Battery」)、またはピリオドのない短い行は見出し(Statement)になります。
- shall、must、will、should を含む各文は、現在の見出しの下の Requirement になります。
- その他のテキストは直前の項目の説明に加わります。
- 番号付けのパターン(テキストから検出、または入力)がある場合は、パターンがレベルを決めます。
スプレッドシートから要求を更新する
スプレッドシートで多数の要求を一度に変更するには、この方法を使います。
- データベース(または要求ページ)でエクスポート…をクリックし、Table (CSV) を選択します。
- 編集する属性にチェックを入れます。含めるの下で ID にチェックを入れ、エクスポートをクリックします。
- スプレッドシートで値を編集します。ID 列は変更しないでください。
- ファイルをインポートします。マッピングで ID 列がグローバル IDにマッピングされていることを確認し、Match existing entities by をグローバル IDに設定します。
- 確認で Create a document… のチェックを外します。
照合された行は更新された項目として数えられ、変更された各フィールドが一覧表示されます。
- Import N items をクリックします。
このリリースより前にエクスポートされたファイルの I_… の値は一致しません。ID 列を使ってください。すべてのステップとオプションについては、インポートとエクスポートを参照してください。
更新で書き込まれるもの:
- マッピングした列だけ。Description 列がない場合、既存の説明はそれぞれそのまま残ります。
- ファイルのラベルは既存のラベルに追加されます。
- Class 列がない場合、Global ID で照合された行はそのエンティティのクラスを保ちます。
インポートのメッセージ
| メッセージ | 意味と対処法 |
|---|---|
| 「名前」または「番号」にマッピングされた列がありません。どちらかをマッピングしてください。 | 少なくとも 1 つの列を Name または Number にマッピングします。 |
| 行 N: 不明なクラス「X」。<class> を使用します。 | Class の値がどのクラスにも一致しません。値を修正するか、列を「スキップ」にマッピングします。 |
| 行 N: 不明なラベル「X」は無視しました。 | 先にスキーマでラベルを作成するか、値を修正します。 |
| 行 N: 「<attribute>」はクラス <class> に適用されません。 | 行のクラスにその属性がありません。 |
| 行 N: 「<value>」は「<attribute>」の有効な <type> ではありません。 | 値を数値、日付、選択肢などとして読み取れません。日付形式のオプションを確認します。 |
| 行 N: 名前が 255 文字を超えているため短縮しました。/ 行 N: 番号が 255 文字を超えているため短縮しました。 | 名前と番号は 255 文字までです。 |
| 番号 X が重複しています(行 A と B)。 | 2 つの行が同じ番号を持っています。階層の構築で、子が最初の行に付けられることがあります。 |
| 行 N: X の親番号 P がありません。Q に配置しました。/ …。最上位にインポートしました。 | 直接の親の番号がファイルにありません。 |
| 行 N: 親番号 P が見つかりません。/ 行 N: 親 P が見つかりません。 | Parent Number または Parent Row ID が、ファイルにない行を参照しています。 |
| 行 N: 「<relationship>」のターゲット「X」が見つかりません。 | 関係の列が、存在しないエンティティを指しています。Match related entities by を確認します。 |
| 行 N: A から B への「<relationship>」はスキーマで許可されていません(作成はしました)。 | スキーマに載っていないにもかかわらず、リンクが作成されました。 |
| A と B の間の関係「X」はスキーマで許可されていないため、スキップしました。 | ReqIF または XMI の関係を、traced to としても作成できませんでした。 |
| 画像 X: .ext の画像はサポートされていないため、スキップしました。保持するには、Word で画像を PNG または JPEG として保存してください。 | サポートされていない形式の Word の画像。 |
| Image X (size) exceeds the <limit> attachment limit and was skipped.(画像 X(サイズ)は添付ファイルの上限 <limit> を超えているため、スキップされました。) | 画像がファイルごとの上限を超えています。 |
| No data rows were found.(データ行が見つかりませんでした。) | ファイルまたはシートに見出ししかないか、空です。 |
| Could not read the file: Excel 97-2003 (.xls) files are not supported. In Excel, save the file as .xlsx or .csv, then import it again(ファイルを読み取れませんでした:Excel 97-2003(.xls)ファイルはサポートされていません。Excel でファイルを .xlsx または .csv として保存し、もう一度インポートしてください) | ファイルを変換します。 |
| Could not read the file: XML with a DOCTYPE or ENTITY declaration is not accepted. Save the file without it and import it again(ファイルを読み取れませんでした:DOCTYPE または ENTITY 宣言を含む XML は受け付けられません。宣言を除いてファイルを保存し、もう一度インポートしてください) | ReqIF または XML ファイルから宣言を除去します。 |
| Could not read the file: invalid XML(ファイルを読み取れませんでした:無効な XML) | ReqIF ファイルが整形式の XML ではありません。 |
| インポートに失敗しました: <reason> | インポートが停止しました。何も変更されていません。 |
要求のショートカット
| キー | 場所 | Action |
|---|---|---|
| Enter | ドキュメントのクイック入力 | 入力した要求を追加します。 |
| ⌘ / Ctrl+Enter / ⌥ / Alt+⌘ / Ctrl+Enter | ドキュメント、項目を選択中 | 兄弟 / 子を追加します。 |
| Enter または Space | 品質、TBD/TBR、確認するリンクの行 | 行の要求またはレビュー対象の項目をインスペクターに表示します。 |
| ↑ / ↓ | 同じ行、行にフォーカスあり | 前または次の行に移動します。 |
| ⌘ / Ctrl+クリック、⇧ / Shift+クリック、⌘ / Ctrl+⇧ / Shift+クリック | 品質、TBD/TBR、確認するリンクの行、データベースの行、ドキュメントの項目 | 行を切り替える、最後にクリックした行からの範囲を選択する、その範囲を追加する。 |
| ⌘A / Ctrl+A, ⇧ / Shift+↑ / ⇧ / Shift+↓ | 同じ行、行にフォーカスあり | 表示中のすべての行を選択する、フォーカスのある行から選択範囲を広げる。 |
| 右クリック、Shift+F10、またはメニューキー | 要求、品質、TBD/TBR、確認するリンクの行、ドキュメントの項目とアウトラインの項目 | 行のメニューを開きます:理由付きのおすすめの操作と ✦ More AI ▸ が最初で、続いて項目のコマンド。 |
| Esc | 品質、TBD/TBR、確認するリンク、RVTM | 行の選択を解除します。 |
| Enter | ベースラインとバージョンの名前フィールド | プロジェクトのベースラインを作成します。 |
| ⌘Z / Ctrl+Z | どこでも | 最後の変更を元に戻します。インポート全体、リンクのレビュー済み設定、ステータスの変更も含みます。 |
アプリのすべてのショートカットについては、キーボードショートカットを参照してください。
設定
| 設定 | 場所 | 既定 | 範囲 |
|---|---|---|---|
| テキストが変更されたら自動的に再チェック | 品質ページの範囲バー | オフ | このブラウザー |
| インスペクターのグループの折りたたみ・展開(品質とその他) | インスペクターでグループの見出しをクリックするか、リンクの末尾にあるすべて折りたたむ / すべて展開をクリック | 品質は折りたたみ、その他は展開 | このブラウザー、クラスごと |
| 承認、決定、コメントに記録されるあなたの名前 | あなたのアカウント名 | — | アカウント |
| トレースステータス(要求上の点) | ドキュメントの表示 ▾ | 対象 | ドキュメント |
メッセージ
| メッセージ | 場所 | 意味 |
|---|---|---|
| N 件の要求をチェックしました | 品質 | 範囲に対してチェックが実行されました。 |
| この範囲に要求はありません。 | 品質 | 範囲に要求がありません。 |
| This document has no Requirements to check. Statements are not scored.(このドキュメントにはチェックする Requirement がありません。Statement は採点されません。) | ドキュメントの品質チェック | 項目を Requirement に変更するか、別のドキュメントをチェックします。 |
| 古い結果 — 再実行 / 古い / Quality: stale — re-run | 品質、ドキュメント、インスペクター | 前回のチェック後にテキストが変更されました。 |
| Needs a reviewer’s judgment(レビュー担当者の判断が必要) | 品質(Correct、Feasible) | 人が判断する必要があります。✘ をクリックして「はい」にします。 |
| Marked No manually.(手動で「いいえ」に設定されました。) | 品質 | レビュー担当者が基準を「いいえ」に設定しました。 |
| 承認済みの要求 N 件をレビュー中に移動しました。N 件のリンクをレビュー対象にしました。 | 編集後 | 編集によって承認が再オープンされ、リンクがレビュー対象になりました。 |
| 承認しました / 却下しました / レビュー中に移動しました | 承認ボックス | 決定が記録されました。 |
| N 件のリンクをレビュー済みにしました。 | 確認が必要なリンク | レビューが記録されました。 |
| 先にレビュー済みにするリンクを選択してください。 | 確認が必要なリンク | 選択したものをレビュー済みにする…の前に行にチェックを入れます。 |
| 完了 / 属性を閉じました。テキストにはまだ TBD が含まれています。 | TBD/TBR | 属性が None に設定されました。 |
| テキストにはまだ TBD が含まれています。閉じるにはテキストを編集してください。 | TBD/TBR | テキストだけの項目を閉じようとしたときに表示されます。 |
| ベースラインを保存しました | ドキュメント、ベースラインとバージョン | スナップショットが保存されました。 |
| This document has no baseline. Save one first.(このドキュメントにはベースラインがありません。先に保存してください。) | 現在と比較、変更レポート | ドキュメントにベースラインがありません。 |
| 「<name>」に戻しました / 「<name>」を復元しました | ベースライン | ドキュメントまたはプロジェクトが巻き戻されました。元に戻せます。 |
| レビューする要求がありません。先に要求を選択するか開いてください。 | AI 要求チェック | 範囲に要求がありません。 |
制限事項
- 品質チェック:範囲内のすべての要求が、重複を探すために他の要求と比較されます(類似度のしきい値 75%)。
- AI 要求チェック:AI リクエスト 1 件につき 20 件の要求。コンテキストとして最大 300 件の他の要求。
- リンクのレビューの差分は、古い名前の最初の 500 文字と古い説明の 4,000 文字を保持します。
- TBD/TBR のバーンダウン:最大 60 点。
- インポート:
- 名前と番号は 255 文字まで。
- プレビューには最初の 500 行が表示されます。警告は最初の 50 件が一覧表示されます(「…and N more」)。
- 番号付けのパターンは最大 6 レベルです(「The numbering pattern has more than 6 levels. Use at most 6 markers.」)。
- ReqIF/XML ファイルは最大 1 億文字、3,000,000 要素まで。
- .reqifz と .docx のアーカイブは、最大 10,000 エントリ、1 エントリあたり 300 MB、合計 600 MB まで。
- 画像と元の Word ファイルは、ファイルごとの添付ファイル上限内でのみ保持されます(Free プランで 10 MB、Individual で 25 MB、Team で 100 MB)。
関連
- ドキュメント:仕様書、レポート、DOCX 出力を書いて構成します。
- トレーサビリティ:関係、トレーサビリティマトリックス、カバレッジ、影響。
- モデルとデータベース:クエリ、列、一括編集。
- スキーマ拡張:要求の属性、選択肢、ラベルを追加します。
- インポートとエクスポート:すべてのファイル形式。
- ヘルプ:要求、ステータス、承認、要求の品質、TBD/TBR 登録簿、確認するリンク、承認、インポート、ベースラインとバージョン、RVTM。