コースのチャプター
トレーニング · トラック 1. はじめに · チャプター 1.5(全 8 チャプター)
1.5 ドキュメント 2:46
要求がモデル項目である仕様書を書きます。
Holarch 1.27 の画面です。
学習内容
- 組み込みテンプレートから要求仕様書を作成する
- セクションの下に要求を追加し、その shall 文を書く
- クイック追加で複数の要求をすばやく追加する
- ドキュメントの要求を、データベースでモデル項目として見つける
- 納品メニューから仕様書を Word にエクスポートする
組み込みテンプレートから Bike-Share Dock のシステム要求仕様書を作成し、+ 子とインスペクターでセクションの下に要求を書き、クイック追加でさらに追加し、ドキュメント内のすべての要求がデータベースのモデル項目であることを確認して、ドキュメントを Word にエクスポートします。
プロジェクトファイル
- 開始時のプロジェクト (.holarch.json。プロジェクトを管理 → プロジェクトファイル ▾ → プロジェクトをインポート (.json)…)
- 完成したプロジェクト (.holarch.json。プロジェクトを管理 → プロジェクトファイル ▾ → プロジェクトをインポート (.json)…)
動画は holarch.app から再生されます。プライバシーポリシーをご覧ください。
演習
CubeSat EO-1 デモプロジェクトを使って、Holarch で実際に操作します。
- EO-1 デモプロジェクトを開きます(または作成します:プロジェクトを管理 → プロジェクトファイル ▾ → 新しいデモプロジェクト → CubeSat(ガイド付きシステムズエンジニアリング))。
- ニーズと要求 → ドキュメントを開き、+ 新しいドキュメントをクリックします。名前を
EO-1 Ground Station Specificationにし、テンプレート Requirements Specification を選んで作成をクリックします。 - セクション 4.1 Primary Functions を選択して+ 子をクリックし、要求に
Track the Spacecraftという名前を付けて、インスペクターの説明にその shall 文を書きます。 - 下部のクイック追加で 10 Design Constraints の下を選び、
The ground station antenna shall have a diameter of no more than 3.7 m.と入力して Enter キーを押します。同じ方法で 2 つ目の制約を追加します。 - データベースを開き、検索ボックスに
in:"EO-1 Ground Station Specification" class:Requirementと入力して新しい要求を一覧表示します。 - ドキュメントに戻り、納品 ▾ → 仕様書(Word)を選んでファイルを開きます。
Word ファイルで、3 つの要求がそれぞれ番号付きのセクションの下に表示されていれば完了です。
確認問題
- Holarch のドキュメントに入力した要求と、ワープロに入力した要求の違いは何ですか?
- クイック追加は、新しい要求の名前をどのように決めますか?
- 「記述ガイダンスを含める」にチェックを入れるのはどんなときですか?
解答を表示
Holarch のドキュメントに入力した要求と、ワープロに入力した要求の違いは何ですか?
Holarch では、ドキュメント内の各要求がモデル項目です。トレースし、品質をチェックし、ダイアグラムに描き、データベースで見つけることができます。
クイック追加は、新しい要求の名前をどのように決めますか?
shall の後の語から要求の名前を付け、選んだセクション内の兄弟項目に続けて番号を付けます。
「記述ガイダンスを含める」にチェックを入れるのはどんなときですか?
作成者がそのドキュメントの種類に不慣れな場合です。各セクションに記載すべき内容の短いメモが入り、書きながら削除します。
関連資料
トランスクリプト
トランスクリプトを表示 (ナレーションと画面の内容)
Introduction
Chapter five: documents. Requirements usually live in a specification. In Holarch a document is an outline of model items, so every requirement in it is an item you can trace, check and draw.
We continue with the Bike-Share Dock project, and write its system requirements specification.
Create from a template
Open Needs and Requirements, then Documents, and click New Document.
On screen: Needs & Requirements → Documents → + New Document.
Name it Bike-Share Dock System Requirements. The templates below are for requirements documents; the menu next to them shows the templates for other kinds of document.
On screen: New Document: name; templates for Requirements Document.
A template gives the document its sections. Include writing guidance adds notes that explain what each section should hold. Choose Requirements Specification, with the sections only, and click Create.
On screen: Template: Requirements Specification → Create.
The document opens with the template's numbered sections, from document control to the appendices. The outline on the left lists them, and clicking an entry jumps to it.
On screen: The new document and its outline.
Write requirements
Select section 4.1, Primary Functions. Open the menu next to After, and choose Add Child. A new requirement appears under the section, numbered 4.1.1, with its name ready to type. Type Show Available Bikes, and press Enter.
On screen: 4.1 → + After ▾ → Add Child → Show Available Bikes.
Then write the shall statement. Click the description in the inspector, type it, and click elsewhere to save.
On screen: Inspector → Description.
To add many requirements quickly, use Quick add at the bottom of the document. Choose the section Design Constraints, type the requirement, and click Add, or press Enter.
On screen: Quick add → Under 10. Design Constraints → Add.
Holarch adds it under the section, and names it from the words after shall. The cursor stays in the field, so the next requirement is one more line.
On screen: Second Quick add.
One model
Each requirement in the document is a model item. Open the Database and filter to requirements: the new ones are listed with the requirements from chapter two.
On screen: Database → + Filter → Requirement.
Export
Back in the document, the Deliver menu makes the Word file: the specification with a table of contents and the numbered requirements, ready to send for review. Choose Specification (Word).
On screen: Back to the document → Deliver ▾ → Specification (Word).
Recap
Let's recap. You created a specification from a template, wrote a requirement under a section, added more with Quick add, saw that they are model items, and exported the document to Word.
Next, you learn the quickest ways to find anything in a growing model.