Holarch
Kurs bölümleri

Eğitim · Kurs 1. Başlarken · Bölüm 1.5 / 8

1.5 Belgeler 2:46

Gereksinimleri model öğeleri olan bir şartname yazın.

Holarch 1.27'yi gösterir.

Neler öğreneceksiniz

  • Yerleşik bir şablondan bir gereksinim şartnamesi oluşturun
  • Bir bölümün altına bir gereksinim ekleyin ve shall ifadesini yazın
  • Hızlı ekle ile birkaç gereksinimi hızla ekleyin
  • Bir belgenin gereksinimlerini Veritabanı'nda model öğeleri olarak bulun
  • Şartnameyi Teslim et menüsünden Word'e dışa aktarın

Bike-Share Dock'un sistem gereksinimleri şartnamesini yerleşik bir şablondan oluşturun, + Alt ve özellik paneliyle bir bölümün altına bir gereksinim yazın, Hızlı ekle ile daha fazlasını ekleyin, belgedeki her gereksinimin Veritabanı'nda bir model öğesi olduğunu görün ve belgeyi Word'e dışa aktarın.

Proje dosyaları

  • Başlangıç projesi (.holarch.json; Projeleri yönet → Proje dosyaları ▾ → Proje içe aktar (.json)…)
  • Bitmiş proje (.holarch.json; Projeleri yönet → Proje dosyaları ▾ → Proje içe aktar (.json)…)

Video holarch.app'ten oynatılır; bkz. Gizlilik Politikası.

Alıştırma

Bunu Holarch'ta, CubeSat EO-1 demo projesinde kendiniz yapın.

  1. EO-1 demo projenizi açın (veya oluşturun: Projeleri yönet → Proje dosyaları ▾ → Yeni demo proje → CubeSat (Rehberli sistem mühendisliği)).
  2. İhtiyaçlar ve gereksinimler → Belgeler'i açın ve + Yeni belge'ye tıklayın. Adını EO-1 Ground Station Specification koyun, Gereksinim şartnamesi şablonunu seçin ve Oluştur'a tıklayın.
  3. 4.1 Primary Functions bölümünü seçin, + Alt'a tıklayın, gereksinime Track the Spacecraft adını verin ve shall ifadesini özellik panelinin açıklamasına yazın.
  4. En alttaki Hızlı ekle'de Altına: 10 Design Constraints'i seçin, The ground station antenna shall have a diameter of no more than 3.7 m. yazın ve Enter'a basın. Aynı şekilde ikinci bir kısıt ekleyin.
  5. Veritabanı'nı açın ve yeni gereksinimleri listelemek için arama kutusuna in:"EO-1 Ground Station Specification" class:Requirement yazın.
  6. Belgeye geri dönün, Teslim et ▾ → Şartname (Word)'ü seçin ve dosyayı açın.

Word dosyası üç gereksiniminizi numaralı bölümlerinin altında gösterdiğinde işiniz bitmiştir.

Kendinizi sınayın

  1. Bir Holarch belgesine yazılan bir gereksinim ile bir kelime işlemciye yazılan bir gereksinim arasındaki fark nedir?
  2. Hızlı ekle yeni gereksinimin adını nasıl seçer?
  3. Yazım rehberini dahil et'i ne zaman işaretlersiniz?
Yanıtları göster
  1. Bir Holarch belgesine yazılan bir gereksinim ile bir kelime işlemciye yazılan bir gereksinim arasındaki fark nedir?

    Holarch'ta belgedeki her gereksinim bir model öğesidir: onu izleyebilir, kalitesini denetleyebilir, diyagramlarda çizebilir ve Veritabanı'nda bulabilirsiniz.

  2. Hızlı ekle yeni gereksinimin adını nasıl seçer?

    Gereksinimi shall'dan sonraki sözcüklerden adlandırır ve seçilen bölümdeki kardeşlerinden sonra numaralandırır.

  3. Yazım rehberini dahil et'i ne zaman işaretlersiniz?

    Yazarlar belge türüne yeni olduğunda: her bölüm o zaman neleri içermesi gerektiğine dair kısa bir not alır; siz yazdıkça onu silersiniz.

Daha fazla bilgi

Döküm

Dökümü göster (anlatım ve ekranda görünenler)

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.