コースのチャプター
トレーニング · トラック 4. ドキュメントと成果物 · チャプター 4.1(全 5 チャプター)
4.1 ドキュメントテンプレート 2:54
テンプレートから計画書や仕様書を作成し、各セクションのガイダンスを利用します。
Holarch 2.13 の画面です。
学習内容
- 組み込みテンプレートから、選んだ種類のドキュメントを作成する
- 記述ガイダンスを含め、セクション内のガイダンスを読む
- セクションのガイダンスを自分のテキストに置き換えて保存する
- ドキュメントの各セクションがモデル項目である理由を説明する
組み込みテンプレートから Bike-Share Dock のシステムズエンジニアリング管理計画書を作成します。ドキュメントの種類を選び、アウトラインとガイド付きテンプレートを比較し、各セクションのガイダンスを読み、自分のテキストに置き換えて、すべてのセクションがモデル項目であることを確認します。
プロジェクトファイル
- 開始時のプロジェクト (.holarch.json。プロジェクトを管理 → プロジェクトファイル ▾ → プロジェクトをインポート (.json)…)
- 完成したプロジェクト (.holarch.json。プロジェクトを管理 → プロジェクトファイル ▾ → プロジェクトをインポート (.json)…)
動画は holarch.app から再生されます。プライバシーポリシーをご覧ください。
演習
CubeSat EO-1 デモプロジェクトを使って、Holarch で実際に操作します。
- EO-1 デモプロジェクトを開くか、作成します:プロジェクトを管理 → プロジェクトファイル ▾ → 新しいデモプロジェクト → CubeSat(ガイド付きシステムズエンジニアリング)。
- ニーズと要求 → ドキュメントを開き、+ 新しいドキュメントをクリックします。名前を
EO-1 Interface Control Documentにします。 - 対象のテンプレートで Interface Control Document を選び、記述ガイダンスを含めるにチェックを入れ、Interface Control Document (ICD) カードを選んで作成をクリックします。
- セクション 2.3 Interface Owners and Change Authority を選択し、そのガイダンスを読みます。説明をクリックし、ガイダンスを EO-1 インターフェースのオーナー(たとえば Payload Lead と Comms Lead)に置き換えて、⌘ / Ctrl↵ を押して保存します。
- セクション 3.2 Interface Matrix を選択し、テンプレートがそこに配置したライブのインターフェースマトリックスを確認します。
- チェック付きのウォークスルーを行うには、チュートリアル 11「成果物を作成する」を実行します(ヘルプ → チュートリアル)。
新しい ICD の 2.3 にガイダンスではなく自分のテキストが表示され、3.2 に EO-1 のコンポーネントのマトリックスが表示されれば完了です。
確認問題
- 「新しいドキュメント」が最初に表示するテンプレートは何によって決まりますか?
- 記述ガイダンスありのテンプレートとなしのテンプレートの違いは何ですか?
- 各セクションがモデル項目であることが重要なのはなぜですか?
解答を表示
「新しいドキュメント」が最初に表示するテンプレートは何によって決まりますか?
「対象のテンプレート」で選んだドキュメントの種類です。他の種類のテンプレートも「その他のテンプレート」に表示されます。ドキュメントには選んだテンプレートの種類が設定されます。
記述ガイダンスありのテンプレートとなしのテンプレートの違いは何ですか?
どちらも同じ番号付きセクションと初期の表を備えています。ガイダンスありでは、各セクションの冒頭に記載すべき内容の短いガイドも入り、書きながらそれを置き換えます。
各セクションがモデル項目であることが重要なのはなぜですか?
セクションは Statement なので、要求と同じようにリンク、コメント、ベースライン化ができ、ドキュメントはモデルのビューのままです。
関連資料
トランスクリプト
トランスクリプトを表示 (ナレーションと画面の内容)
Introduction
Welcome to track four: documents and deliverables. Programs are reviewed through their documents: plans, specifications, and the matrices reviewers ask for. In Holarch, these are built from the model. This first chapter covers document templates.
You will pick a document type and its template, compare an outline with a template that has guidance, and write your own text over that guidance.
Choose a type
We continue with the Bike-Share Dock. It already has requirements, functions, parts and test cases. Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
The type decides which templates are offered. Holarch has templates for the documents most programs write, from the concept of operations to the test plan, and for the concept stage: needs analysis, concept exploration and concept definition.
On screen: Card: document types with templates.
Name it Bike-Share Dock SEMP. Then, under Templates for, choose Systems Engineering Management Plan Document.
On screen: Name, then Templates for ▾ → Systems Engineering Management Plan Document.
Outline or guidelines
Each template comes in two forms. The outline has only the section headings. With writing guidance, every section also explains what it should hold, with an example. Tick Include writing guidance, choose the template, and click Create.
On screen: Include writing guidance → the template card → Create.
The plan opens with fifteen numbered sections: the life cycle, the technical reviews, requirements management, baselines, interfaces, verification, risk, and the tools and model.
On screen: The new plan and its outline.
Write your plan
Click section 2.1, Purpose. Its text is the guidance: state why this plan exists and who uses it, followed by an example.
On screen: Outline → 2.1 Purpose.
Replace the guidance with your own text. Click the description to edit it, select its text, and type the purpose of this plan. Then press Command Return to save it.
On screen: Edit 2.1's description → type → Save.
The guidance often points to where the work lives in Holarch. Section 8.1, Baselines, says to use Holarch baselines, so that later changes can be compared against them. Chapter four of this track shows how.
On screen: Outline → 8.1 Baselines.
Every section is a model item, a statement, so you can link it, comment on it and baseline it, like a requirement.
On screen: 8.1's class badge: Statement.
Recap
Let's recap. You chose a document type and its template, picked the template with guidelines, read the guidance in a section, and replaced it with your own text.
Next, you put live traceability and verification matrices into a document.