Holarch
Главы курса

Обучение · Курс 1. Начало работы · Глава 1.5 из 8

1.5 Документы 2:46

Напишите спецификацию, требования которой являются элементами модели.

Показан Holarch 1.27.

← 1.4 Ваша первая диаграмма · Все главы · 1.6 Поиск →

Чему вы научитесь

  • Создавать спецификацию требований из встроенного шаблона
  • Добавлять требование в раздел и писать его формулировку с «shall»
  • Быстро добавлять несколько требований через «Быстрое добавление»
  • Находить требования документа в Базе данных как элементы модели
  • Экспортировать спецификацию в Word из меню «Поставка»

Создайте спецификацию системных требований станции Bike-Share Dock из встроенного шаблона, напишите требование в разделе через + Дочерний и инспектор, добавьте ещё несколько через «Быстрое добавление», убедитесь, что каждое требование документа — элемент модели в Базе данных, и экспортируйте документ в Word.

Файлы проектов

  • Начальный проект (.holarch.json; Управление проектами → Файлы проекта ▾ → Импортировать проект (.json)…)
  • Готовый проект (.holarch.json; Управление проектами → Файлы проекта ▾ → Импортировать проект (.json)…)

Видео воспроизводится с holarch.app; см. Политику конфиденциальности.

Практика

Выполните это сами в Holarch на демо-проекте CubeSat EO-1.

  1. Откройте свой демо-проект EO-1 (или создайте его: Управление проектами → Файлы проекта ▾ → Новый демо-проект → CubeSat (пошаговая системная инженерия)).
  2. Откройте Потребности и требования → Документы и нажмите + Новый документ. Назовите его EO-1 Ground Station Specification, выберите шаблон Спецификация требований и нажмите Создать.
  3. Выберите раздел 4.1 Primary Functions, нажмите + Дочерний, назовите требование Track the Spacecraft и напишите его формулировку с «shall» в описании в инспекторе.
  4. В поле Быстрое добавление внизу выберите В 10 Design Constraints, введите The ground station antenna shall have a diameter of no more than 3.7 m. и нажмите Enter. Таким же образом добавьте второе ограничение.
  5. Откройте Базу данных и введите в поле поиска in:"EO-1 Ground Station Specification" class:Requirement, чтобы вывести новые требования.
  6. Вернувшись в документ, выберите Поставка ▾ → Спецификация (Word) и откройте файл.

Готово, когда файл Word показывает три ваших требования в их нумерованных разделах.

Проверьте себя

  1. Чем требование, набранное в документе Holarch, отличается от требования, набранного в текстовом редакторе?
  2. Как «Быстрое добавление» выбирает имя нового требования?
  3. Когда стоит устанавливать флажок «Включить рекомендации по написанию»?
Показать ответы
  1. Чем требование, набранное в документе Holarch, отличается от требования, набранного в текстовом редакторе?

    В Holarch каждое требование документа — элемент модели: его можно прослеживать, проверять его качество, показывать на диаграммах и находить в Базе данных.

  2. Как «Быстрое добавление» выбирает имя нового требования?

    Оно называет требование по словам после shall и нумерует его после соседних элементов в выбранном разделе.

  3. Когда стоит устанавливать флажок «Включить рекомендации по написанию»?

    Когда авторы не знакомы с этим типом документа: тогда каждый раздел получает краткую заметку о том, что в нём должно быть, и вы удаляете её по мере написания.

Подробнее

Расшифровка

Показать расшифровку (дикторский текст и то, что на экране)

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.