Holarch

Training · Track 4. Documents and Deliverables

Track 4. Documents and Deliverables: exercise sheet

For engineers and leads. One practice task and a few questions per chapter, to work through after each video. Print this page from your browser, or work on screen. The answer key starts on a new page at the end.

Before you start

Take first
Chapter 1.5 Documents; Tracks 2 and 3 make the matrices more useful.
Plan
Free
Project
The Bike-Share Dock: each chapter has its starting file.

4.1 Document Templates

Watch chapter 4.1 (2:54)

Practice

On the CubeSat EO-1 demo project:

  1. Open your EO-1 demo project, or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering).
  2. Open Needs & Requirements → Documents and click + New Document. Name it EO-1 Interface Control Document.
  3. Under Templates for, choose Interface Control Document, tick Include writing guidance, choose the Interface Control Document (ICD) card and click Create.
  4. Select section 2.3 Interface Owners and Change Authority and read its guidance. Click its description, replace the guidance with the owners of the EO-1 interfaces (for example the Payload Lead and the Comms Lead), and press ⌘ / Ctrl↵ to save.
  5. Select section 3.2 Interface Matrix and read the live interface matrix the template placed there.
  6. For a checked walk-through, run tutorial 11 Produce the Deliverable (Help → Tutorials).

You're done when the new ICD shows your own text in 2.3 instead of the guidance, and 3.2 shows a matrix of EO-1 components.

Questions

  1. What decides which templates New Document offers first?
  2. What is the difference between a template with and without writing guidance?
  3. Why does it matter that each section is a model item?

4.2 Live Matrices in Documents

Watch chapter 4.2 (2:48)

Practice

On the CubeSat EO-1 demo project:

  1. Open your EO-1 demo project, or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering).
  2. Open Needs & Requirements → Documents → EO-1 System Requirements Specification and click the description of section 2 Attitude Determination and Control to edit it.
  3. In the rich-text toolbar, open + and choose Matrix…. Pick Requirement Allocation Matrix, keep the scope on this document, click Insert and press ⌘ / Ctrl↵ to save.
  4. Read the caption and the shaded rows. 2.5 Safe Mode Recovery is a gap: nothing satisfies it.
  5. Select 2.5 and, in its Trace section, link F10 Enter Safe Mode under satisfied by. Go back to section 2 and read the matrix again.

You're done when the 2.5 row of the allocation matrix lists F10 Enter Safe Mode and is no longer shaded.

Questions

  1. How does a live matrix differ from a table you type?
  2. Why do you close a gap in the model, not in the matrix?
  3. Which scopes can a matrix cover?

4.3 Word and Excel Output

Watch chapter 4.3 (2:10)

Practice

On the CubeSat EO-1 demo project:

  1. Open your EO-1 demo project, or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering).
  2. Open EO-1 System Requirements Specification and choose Deliver ▾ → Page Setup…. Under Marking, choose Own marking and set a header and footer such as EO-1 Program Internal.
  3. Tick Cover page with Version 2.0 and Prepared by EO-1 Systems Team, tick Page numbers, and click Apply.
  4. Choose Deliver ▾ → Review Copy (Word) and open the file: landscape pages with the attribute columns under each item, and the marking on every page.
  5. Choose Deliver ▾ → Traceability Matrix…. Pick the RVTM, set Model to SRR Baseline and Export as to Matrix (Excel), read the row and gap count, and click Export.

You're done when you have a Word file with the cover page, marking and page numbers, and an Excel RVTM of the SRR Baseline with its gaps shaded.

Questions

  1. Which marking does a document use?
  2. What is the difference between a Word template and a document template?
  3. Where do the Revision History and Approvals tables in a Word export come from?
  4. Why export a matrix from a baseline instead of the current model?

4.4 Review Packages and Baselines

Watch chapter 4.4 (2:35)

Practice

On the CubeSat EO-1 demo project:

  1. Open your EO-1 demo project, or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering). This task also uses the EO-1 Interface Control Document from the Document Templates chapter; create it first if you skipped that chapter.
  2. Open EO-1 System Requirements Specification, click Request Review beside the document type, leave everyone unticked and click Request Review. The strip under the title shows the review.
  3. Click Version ▾ → Save Baseline…, name it PDR Baseline, fill in your role, click + Add Approver for a second approver, and click Create.
  4. Change 2.4 Target Slew to 45 seconds. Then choose Version ▾ → Compare Versions… with From PDR Baseline and To Current version, and click Changes (Excel).
  5. Open Control & Reviews → Reviews, click + New Review Package and name it PDR review package. Choose Write ▾ → Insert ▸ Document… twice to add the SRS and the ICD.
  6. Choose Deliver ▾ → Deliverable Setup… and set Export each part from to PDR Baseline for the SRS part, then choose Deliver ▾ → Specification (Word).

You're done when the change report lists the 2.4 edit and the package's Word file has Part A and Part B, with the SRS part from PDR Baseline.

Questions

  1. What does a document baseline hold, and can it change later?
  2. How does a document baseline differ from a project baseline?
  3. Your package should export the baselined SRS, not today's edits. How?
  4. What happens to a review after you click Request Review?

4.5 Presentations from the Model

Watch chapter 4.5 (1:59)

Practice

On the CubeSat EO-1 demo project:

  1. Open your EO-1 demo project, or create it: Manage Projects → Project Files ▾ → New Demo Project → CubeSat (Guided systems engineering).
  2. Open Plan → Presentations and click + New Presentation. Name it EO-1 PDR Briefing, set Start from to A document outline with EO-1 System Requirements Specification, and click Create.
  3. Double-click the title on the first slide, type EO-1 Preliminary Design Review and press Esc.
  4. Click + New Slide ▾, choose Blank, then Picture ▾ → Picture of… and pick the FFBD of F0 Perform EO-1 Mission.
  5. Click ▶ Present ▾ → Present from Current Slide, step with → and end with Esc. Then click Export… and choose Presentation (PowerPoint).

You're done when the deck has a title slide, one slide per SRS section and a live FFBD picture, and you have the PowerPoint file.

Questions

  1. What keeps a picture on a slide up to date?
  2. When would you start a deck from a document outline?
  3. Which formats can a deck be exported to?

Answer key

4.1 Document Templates

  1. The document type chosen under Templates for. Templates of other types are still listed under Other templates; the document gets the type of the template you choose.
  2. Both give the same numbered sections and starter tables. With guidance, each section also starts with a short guide to what it should hold, which you replace as you write.
  3. A section is a Statement, so you can link it, comment on it and baseline it like a requirement, and the document stays a view of the model.

4.2 Live Matrices in Documents

  1. The block stores only which matrix and scope to show. Holarch rebuilds the rows from the model every time the document is shown or exported, so it never goes out of date.
  2. A live matrix cannot be edited cell by cell. The gap is a missing link or attribute in the model, and fixing it there updates every matrix and view that shows it.
  3. One document's items, all parts of a compilation, or the whole project. The interface and N² matrices can also cover the children of one Asset or Action.

4.3 Word and Excel Output

  1. The nearest one: the document's own marking, else the project's, else the organization's. No marking leaves it unmarked.
  2. A document template fills the content: sections and starter tables. A Word template shapes the Word file: contents, caption numbers, page size and front-matter tables.
  3. From the document's baselines and their approval records, when the Word template includes them, as Specification does.
  4. A review board marks up what was agreed. Choosing a baseline under Model exports the matrix as it was at that baseline, not as it is today.

4.4 Review Packages and Baselines

  1. A read-only snapshot of the document: its items, their attributes and relationships, and the items one relationship away. You can rename it and add approvals, but existing approval records cannot be edited.
  2. A document baseline holds one document and is saved from its Version ▾. A project baseline holds every item in the project and is saved with + Save Baseline… on Control & Reviews → Baselines & Versions.
  3. In the package, set Export each part from to that baseline in Deliverable Setup…. A pinned part shows 📌 and the baseline name, and exports the baseline's content.
  4. The document is In Review. The project's reviewers, or the people you named, get it under Documents to review on My Work and approve or reject it there or in the strip under the title.

4.5 Presentations from the Model

  1. A picture made with Picture of… shows a view of the model, not a copy. When the diagram, document or chart changes, the slide shows the change.
  2. When the briefing follows a document: you get a title slide plus one slide per top-level section with the section text, ready to trim.
  3. PowerPoint, Word and a web page for the whole presentation, and PNG or SVG for the current slide.

Published by Holarch