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.