Holarch

ガイド · インターフェース

インターフェース管理文書(ICD):含める内容と最新に保つ方法

このガイドを聴く(英語音声) 20 min

インターフェース管理文書は、システムの二つの部分の境界を越えるものを記録し、両側のチームを同じ定義に拘束します。このガイドでは、ICD に含める内容、担当者、そもそもインターフェースをどう見つけるか、設計の変化に合わせてドキュメントをどう一貫させるかを扱い、小型の地球観測衛星の二つのサブシステムを実践例として使います。

このページの内容
  1. インターフェース管理文書とは
  2. ICD の担当者
  3. ICD に含める内容
    1. データとタイミングは最も詳しく
    2. インターフェースそのものの検証
  4. アーキテクチャからインターフェースを見つける
  5. ICD をモデルに結び付けておく
  6. インターフェースの変更管理
  7. よくある失敗パターン
  8. 実践例:CubeSat の C&DH から通信系へ
    1. やり取りを見つける
    2. リンクとそれが運ぶもの
    3. インターフェース図
    4. 生成された ICD
    5. この例が示すこと
  9. Holarch で試す
  10. 次に読むもの

インターフェース管理文書とは

統合時の問題のほとんどは、サブシステムの内部ではなく、二つのサブシステムの継ぎ目にあります。あるチームはコネクターのキーが一方向だと想定し、もう一方のチームは逆だと想定します。一方は 100 ms ごとにステータスメッセージを送り、もう一方のタイムアウトは 80 ms です。インターフェース管理文書は、この継ぎ目を明示するためにあります。両側が合意した一つの場所で、両者の間を何がどのような条件で行き来するかを記述します。

ICD はインターフェースを外側から記述します。どちらの側がどう作られているかではなく、各側が境界で何を提示しなければならないかだけを述べます。コネクターとそのピン、電圧と電流、メッセージのレイアウトとタイミング、取り付け点、インターフェースが耐えなければならない環境です。各チームは、それに合わせて自分の側を設計します。

関連する三つのドキュメント名がよく混同されます。

ドキュメント答える問い典型的な内容
インターフェース要求仕様書(IRS)インターフェースは何をしなければならないか?一つ以上のインターフェースに対する要求。設計が確定する前に、検証可能な「shall」の要求文として書かれる。
インターフェース設計記述書(IDD)一方の側はそれをどう実装するか?一方の当事者が作るインターフェースの設計。多くはソフトウェアまたはハードウェアの品目で、製造してテストできるだけの詳細を含む。
インターフェース管理文書(ICD)両側は何に合意したか?特定の二者間のインターフェースについて、管理され、共同で承認された定義。変更管理下に置かれる。

プログラムによって、これらの組み合わせ方は異なります。要求を ICD に含めるプログラムもあれば、早い段階で IRS を書き、設計が成熟してから ICD を書くプログラムもあります。重要なのは、要求と合意された定義の両方が記録され、どちらが管理の基準となるかが明確なことです。

ICD の担当者

ICD には二つ(ときにはそれ以上)の当事者と、一人の担当者がいます。当事者は、それぞれの側に責任を持つ組織やチームです。二つのサブシステムチーム、プライム契約者と供給者、機体チームとペイロードチームなどです。担当者は、ドキュメントを維持し、未決事項を追いかけ、承認を進める人またはグループです。大規模なプログラムでは、それはインターフェース管理ワーキンググループ(ICWG)です。各側の代表者と統合に責任を持つシステムエンジニアが、定期的に集まります。

いくつかの担当ルールで、ほとんどの争いを防げます。

  • インターフェースごとに一人の担当者を、ドキュメントで名指しします。「システムチーム」は担当者ではなく、名前の挙がったリードが担当者です。
  • 両方の当事者が承認します。一方だけが署名した ICD は希望リストであり、管理文書ではありません。
  • 統合するレベルが、その子の間のインターフェースを担当します。二つのサブシステム間のインターフェースはシステムレベルに属します。どちらのサブシステムも単独では決められないからです。
  • プログラムの外の機器やシステムへの外部インターフェースは、プログラム側が担当し、外部の当事者と合意します。外部の当事者が独自のドキュメントを持ち、それが優先されることもあります。

ICD に含める内容

正確な構成は分野とプログラムの規格によりますが、完全な ICD は同じ範囲をカバーします。セクションは削除せず「該当なし」として残し、検討したことがレビュー担当者にわかるようにします。

セクション記録する内容
識別と当事者インターフェースの番号と名前、二つの当事者、担当者、ドキュメントのステータス、承認。
インターフェースの概要両側とその間のすべてのリンクの図と、インターフェースの目的の短い記述。
インターフェースのリスト個々のリンク(ハーネス、バス、ライン、配管、取り付け)。それぞれの番号、端点、ステータスを含む。
機械と物理取り付け点とボルトパターン、包絡域と立入禁止区域、インターフェースでの質量特性、アライメント、コネクターの種類と位置。
電気ピン配置、電圧と電流の範囲、電力品質、接地とボンディング、シールド、絶縁、信号レベル。
データとプロトコルプロトコルと物理層、フィールド名、型、範囲、単位、スケーリングを含むメッセージ定義、識別子、エラー処理。
タイミングメッセージの頻度と周期、レイテンシーの予算、起動とウェイクのシーケンス、タイムアウトと、それが切れたときに各側が行うこと。
流体、熱、光学該当する場合、境界での流量、圧力、温度、境界を越えて伝わる熱、光路と視野。
環境インターフェースが耐えなければならない振動、衝撃、温度、湿度、侵入、電磁両立性の条件。
インターフェース要求インターフェースが満たさなければならない要求。それぞれ親の要求にトレースされる。
検証各要求をインターフェースでどう検証するか(テスト、解析、検査、実証)、どのレベルで、どの機器で行うか。
未決事項すべての TBD(まだ決まっていない値)と TBR(提案済みだが未確認の値)。それぞれに担当者と解決日を付ける。
変更履歴各改訂と、その変更要求、変更内容、承認者。

データとタイミングは最も詳しく

機械と電気のインターフェースは、フィットチェックや最初の通電で、早い段階で物理的に確認される傾向があります。データとタイミングの不一致はずっと長く生き残り、システム統合まで残ることもよくあります。各側が、ドキュメントを自分なりに読んで作った自分のシミュレーターに対してテストするからです。メッセージごとに、識別子、周期とその許容差、各フィールドの型、範囲、単位、スケーリング、バイトオーダー、そしてメッセージが遅れた、欠けた、範囲外だったときに受信側が何をするかを書き留めます。単位、符号の規約(充電と放電のどちらを正とするか)、分解能なしに「battery current」とだけ書かれたメッセージ定義は、まだ管理されていません。

インターフェースそのものの検証

インターフェース要求もほかの要求と同様に検証されます(方法、レベル、証拠は要求検証マトリックスのガイドで扱っています)。ただし、証拠には特別な形があります。両側が必要なのです。実機同士、または一方の実機と検証済みの他方のエミュレーターとの間の互換性テストは、ICD を個別に読んだ二つの別々のテストよりも強い証拠です。必要なときに機器とスケジュールがそろうように、これらのテストを ICD の中で計画します。

アーキテクチャからインターフェースを見つける

ICD は、誰かが見つけたインターフェースしか管理できません。確実に見つける方法は、記憶ではなくアーキテクチャから探すことです。

  1. 機能から始めます。ミッションを機能とその入力と出力に分解します(方法は機能分析のガイドを参照)。N² 図は機能(またはサブシステム)を対角線上に置き、行 A、列 B のセルには A が B に送るものが入ります。対角線以外の埋まったセルはどれも、経路を必要とするやり取りです。埋まったセルの集まりは、どの機能がまとまるかを示し、混み合った行や列は、多くの機能が依存している機能を示します。
  2. 機能をコンポーネントに割り当てます。各機能が物理的な部品によって実行されるようになると、異なる部品にある機能間のやり取りはすべて、部品の境界を越えるやり取りになります。その割り当ての方法と確認方法はシステムアーキテクチャのガイドで示しています。
  3. 境界を越えるすべてのやり取りに物理的な経路を与えます。ハーネス、バス、無線リンク、配管、機械的な結合です。経路のないやり取りは設計のギャップであり、何も運ばない経路は、不要であるか、まだ理解されていないかのどちらかです。
  4. インターフェース図を描きます。当事者の組ごとに、両側、境界にあるそれぞれの内部部品、そして運ぶものを付けた各リンクを示します。これが ICD の概要図になります。

インターフェースは見つけた順に番号を付けます。下の実践例では、リンクに IF-01 から IF-25 の番号を付け、大きなインターフェースの中のリンクには小数を付けています(IF-14 の中の IF-14.1)。番号があると、要求、テスト手順、変更要求でインターフェースを引用でき、名前が変わってもインターフェースのリストが安定します。

ICD をモデルに結び付けておく

独立したワープロのファイルとして書かれた ICD は、承認されたその日から設計とずれ始めます。ハーネス図でピンが割り当て直され、ソフトウェアでメッセージの周期が変わり、遅れて来た要求のために新しい信号が追加され、ICD は数週間後に更新されるか、まったく更新されません。そうなると、レビュー担当者は設計とではなく、ドキュメント同士を比較することになります。

モデルベースシステムズエンジニアリングはこれを逆転させます。各インターフェースはシステムモデルの要素であり、二つの端点、運ぶアイテム、それを規定する要求につながっています。ICD はそれらの要素から生成されるレポートです。そうすると、次のようになります。

  • 同じリンクが、ICD、インターフェース図、要求のトレース、検証マトリックスに同じ値で現れます。どれも一つの定義を読むからです。
  • メッセージの頻度やコネクターの変更は次に生成される ICD に現れ、変更履歴はモデル自身の記録から得られます。
  • チェックがモデル上で実行されます。それを運ぶリンクのない二つの部品間のやり取り、端点が一つしかないリンク、負荷が容量を超えるリンク、担当者やステータスのないリンクです。
  • インターフェースに対する要求はそれにトレースされるため、ICD の要求と検証のセクションは完全に保たれます(リンクの種類とギャップのチェックは要求トレーサビリティのガイドを参照)。

すべてをモデルの属性に入れる必要はありません。詳細なコネクター図、タイミング図、長いメッセージカタログは、添付または参照されるドキュメントに残してもかまいません。それでもモデルはインターフェース、そのステータス、担当者、参照を保持するため、生成された ICD は正しい改訂版を指します。

インターフェースの変更管理

インターフェースの定義は段階的に成熟し、その段階によって変更の扱い方が決まります。ほとんどのプログラムでは、単純な四段階の方式で十分です。

ステータス意味変更の方法
Draft(下書き)一方の側による最初の定義。担当者が自由に編集する。
Proposed(提案済み)レビューのために相手側の当事者に提示されている。変更はワーキンググループで議論し、記録する。
Agreed(合意済み)両方の当事者が受け入れており、それに基づいて設計を進めてよい。変更には両方の当事者の同意と、各側への影響の記述が必要。
Baselined(ベースライン化済み)承認済みの構成ベースラインの一部。変更委員会が評価して承認する正式な変更要求と、ICD の再発行。

よくある進め方は、システム要求審査までにインターフェースの下書きを作り、基本設計審査の前に合意し、詳細設計審査の前にベースライン化するものです。進め方がどうであれ、ベースライン化されたインターフェースに対する変更要求には、理由、影響を受けるリンクと項目、各当事者の設計、コスト、スケジュールへの影響、影響を受ける要求と検証、そして適用性(どのビルドまたはシリアル番号から変更が適用されるか)を記述するべきです。それらの影響の見つけ方と規模の見積もり方は、変更影響分析のガイドで一歩ずつ示しています。

TBD と TBR は、縮小しなければならないリストとして追跡します。詳細設計審査の時点でまだ未決事項だらけのインターフェースは、ステータスが何であれ、スケジュール上のリスクです。

よくある失敗パターン

  • 誰も見つけなかったインターフェース。機能間のやり取りに物理的な経路が与えられなかったか、外部インターフェース(地上設備、試験装置、オペレーター)が漏れていた。インターフェースのリストは、ハーネスのリストではなくアーキテクチャから作成します。
  • 一方的なドキュメント。一方のチームが ICD を書き、もう一方は正式に合意せず、統合の段階で食い違いが表面化する。Agreed のステータスにする前に、両方の承認を必須にします。
  • 単位と規約の欠落。単位、符号の規約、バイトオーダー、スケーリングのない値は、二通りの読み方を招きます。レビューでは、それぞれを欠陥として扱います。
  • 負荷と容量の比較がない。各メッセージは収まっても、合わせるとバスを超える。各負荷はハーネスに収まっても、合わせると定格を超える。各リンクの負荷を合計し、マージンを含めて容量と比較します。下の例のモデルでは、IF-05 Payload Interface が 400 Mbps のリンクで 480 Mbps のイメージストリップと 0.02 Mbps のコマンドスケジュールを運んでいます。400 Mbps 中 480.02、120 % で、ベンチで見つかるのではなく、統合の前にモデルがフラグを付けています。
  • タイミングが暗黙のまま。頻度は示されていても、許容差とタイムアウト時の動作は示されていない。両方と、相手側が遅れたときに各側が何をするかを記録します。
  • 古いコピー。ICD、ハーネス図、ソフトウェアのメッセージテーブルがそれぞれ独自のバージョンを持っている。一つのソースから生成するか、少なくともどれが基準かを明記します。
  • 担当者のいない未決事項。人と日付のない TBR は未決のまま残ります。それぞれに両方を付けます。
  • 検証の計画が遅すぎる。インターフェースのテストには、両側のハードウェアか検証済みのエミュレーターが必要です。ユニットが届いたときではなく、ICD が合意されたときに計画します。

実践例:CubeSat の C&DH から通信系へ

例として使うのは EO-1 です。高度 500 km の太陽同期軌道から農地を撮影する 6U の地球観測 CubeSat で、モデル全体は MBSE サンプルプロジェクトのガイドで順に説明しています。ここでは宇宙機内部の一つの継ぎ目を取り上げます。1.4 C&DH(コマンド・データ処理。64 GB のペイロードストレージを持つフライトコンピューター)と 1.5 Communications(コマンド用の 1.5.1 UHF Transceiver とペイロードデータ用の 1.5.2 S-band Transmitter)の間です。両側は別々のチームが作り、衛星が実行するすべてのコマンドと地上に送るすべての画像がこの境界を越えます。

やり取りを見つける

モデルの標準的な撮像パス OPS Run Nominal Imaging Pass は、OPS.1 から OPS.12 の 12 の機能に分解され、そのうち 11 はそれを実行する Asset に割り当てられています。その N² 図は、それらを対角線上に、やり取りするアイテムをセルに配置します。

C&DH と通信系の境界を越えるセルは二つです。

  • 行 OPS.2 Receive Imaging Plan(UHF Transceiver が実行)、列 OPS.3 Load Command Schedule(C&DH が実行):Command Packets。無線機から来る復号されたコマンドパケットです。
  • 行 OPS.7 Encode and Store Image(C&DH)、列 OPS.8 Transmit Image Data(S-band Transmitter):Downlink Frames。圧縮されパケット化された画像データです。

三つ目のやり取りは、宇宙機のモードロジックから来るため、このパスには現れません。C&DH のエントリーアクション Enable S-band Transmitter が、S-band Transmitter が実行する F9 Transmit Payload Data に Transmitter Enable Command を送ります。一つのシナリオだけから作ったインターフェースのリストではこれを見落としていたはずです。インターフェースを列挙する前に、モデル全体で機能を Asset に割り当てるのはこのためです。

デモでは、各やり取りに既に物理的な経路があります。それらから一つの管理されたインターフェースを作るため、デモプロジェクトに要素を一つだけ追加しました。親のコンジット IF-26 C&DH to Communications Interface で、両方のサブシステムに接続され、ステータスは Agreed、担当者は Comms Lead、既存の二つのリンクを子に持ちます。以下のそれ以外はすべて、出荷時のままのデモです。

リンク端点媒体とコネクター運ぶもの容量ステータス
IF-07 Radio Command InterfaceUHF Transceiver → C&DHUART、115.2 kbaud。J3(Micro-D 9)Command Packets、0.0096 Mbps(9.6 kbps)0.1 MbpsBaselined(ベースライン化済み)
IF-08 Payload Data InterfaceC&DH → S-band TransmitterSpaceWire。J4(Micro-D 9)Downlink Frames、10 Mbps。Transmitter Enable Command、レート未設定100 MbpsAgreed(合意済み)

各リンクは、それを駆動する要求にトレースされています。IF-07 は 5.2 UHF Command Uplink(「The UHF transceiver shall receive ground commands at 9.6 kbps」)を満たし、IF-08 は 5.1 S-band Downlink Rate(「The S-band transmitter shall downlink payload data at 10 Mbps」)を満たします。

インターフェース図

インターフェース管理図は、二つの当事者を帯として、親インターフェースを中央に、各リンクをステータス、容量、アイテム付きのバーとして示し、各リンクからそれが接続する部品へ線を引きます。

モデルはフライトコンピューターを一つのユニットとして扱っているため、C&DH の帯には部品がありません。両方のリンクは C&DH そのものに終端します。通信系の側では、各リンクが別々の無線機に終端しており、それこそがハーネスチームが知る必要のあることです。

生成された ICD

ICD は同じ要素から Word ドキュメントとしてエクスポートされます。1 ページ目にはインターフェース登録簿とステータスの概要があり、続いて各コンジットに独自のセクションがあり、端点、コネクターとピン、媒体、方向とレート付きの運ばれるアイテム、リンクされた要求、容量チェックが記載されます。

ICD をダウンロード:C&DH と通信系のインターフェースの EO-1 ICD(.docx)。Holarch がエクスポートしたとおりの 3 ページの完全なドキュメントで、エクスポート日は削除してあります。架空の EO-1 デモデータのみを含みます。

この例が示すこと

  • 登録簿はワーキンググループの議題です。IF-07 はベースライン化されているため、その変更は変更要求を通します。IF-08 は合意済みで、変更には C&DH と通信系の両方のチームが必要です。どちらにも未決の TBD や TBR はないため、このインターフェースは全体としてベースライン化する準備ができています。
  • 容量は、媒体が実際に提供するものと照らして確認します。IF-07 は記録された容量 0.1 Mbps で 9.6 kbps を運んでおり、ドキュメントはこれを 10 % と報告しています。1 バイトあたりスタートビットとストップビットが一つずつの 115.2 kbaud の UART は、115,200 × 8 / 10 = 92,160 bit/s のデータを運ぶため、本当の容量は約 92 kbps で、負荷はその約 10.4 % です。どちらにしてもマージンは大きいのですが、記録された数値は切り上げられています。より混み合ったリンクでは、その切り上げが問題を隠すことになります。
  • システムが不合格でもリンクは合格しえます。IF-08 は 100 Mbps の SpaceWire リンクで 10 Mbps のフレームを流しており、容量の 10 % です。制約は一つ下流のインターフェースにあります。IF-12 S-band Downlink は 10 Mbps の無線リンクで 9.6 Mbps を運んでおり、96 % です。より高速なフレームストリームは IF-08 を楽に通過してもアンテナで行き詰まるため、ICD のレビューでは一つのリンクではなく連鎖を見ます。
  • レートのないアイテムは確認されません。Transmitter Enable Command にはデータレートがないため、容量チェックの対象外です。ごく小さいものですが、空の値は未決事項です。レートを与えるか、担当者付きの TBD にします。
  • 親インターフェースは独自の容量を持ちません。リンクのアイテム(ここでは三つ)をまとめ、当事者の組に一つのドキュメント、一人の担当者、一つのステータスを与えます。負荷のチェックは各リンクで実行されます。
  • 変更はトレースできます。ミッションがより高速なダウンリンクに移行すれば、Downlink Frames のレートが一か所で変わり、IF-08 と IF-12 のチェックが再実行され、IF-08 にトレースされた要求 5.1 が、何を再検証すべきかを示します。

Holarch で試す

  1. プロジェクトを管理 → プロジェクトファイル ▾ → 新しいデモプロジェクト → CubeSat(ガイド付きシステムズエンジニアリング)でデモを作成します。
  2. インターフェース → N² 図を開き、アクション OPS Run Nominal Imaging Pass の N² 図を開いて、その機能間のやり取りを確認します。
  3. インターフェース → ICD を開き、+ 新しいダイアグラムをクリックして、左の親 Asset に C&DH、右に Communications を選びます。
  4. 既存のコンジット IF-07 Radio Command Interface と IF-08 Payload Data Interface をパレットから中央のボックスにドラッグします。アイテムと接続も一緒に付いてきます。
  5. リンクを選択して、Interface Status、オーナー、TBD/TBR、Capacity、単位と、リンクされた要求を確認します。
  6. Word ドキュメントにはICD ドキュメントをエクスポートを、表には ICD をエクスポート (CSV) をクリックします。

インターフェース → インターフェース登録簿には、プロジェクト内のすべてのインターフェースがステータスと容量チェックとともに一覧表示されます。デモでは IF-05 が容量超過と表示されます。手順はインターフェース管理文書の作成にあります。ベースライン化されたインターフェースは変更要求を通じて変更します。

次に読むもの