Holarch
Kurs bölümleri

Eğitim · Kurs 4. Belgeler ve teslimatlar · Bölüm 4.1 / 5

4.1 Belge şablonları 2:54

Bir planı veya şartnameyi, her bölüm için rehberlik içeren bir şablondan başlatın.

Holarch 2.13 sürümünü gösterir.

Tüm bölümler · 4.2 Belgelerde canlı matrisler →

Neler öğreneceksiniz

  • Yerleşik bir şablondan seçilen türde bir belge oluşturun
  • Yazım rehberini dahil edin ve bir bölümdeki rehberi okuyun
  • Bir bölümün rehberini kendi metninizle değiştirin ve kaydedin
  • Her belge bölümünün neden bir model öğesi olduğunu açıklayın

Bike-Share Dock'un sistem mühendisliği yönetim planını yerleşik bir şablondan oluşturun: belge türünü seçin, ana hattı ve rehberli şablonu karşılaştırın, her bölümdeki rehberi okuyun, onu kendi metninizle değiştirin ve her bölümün bir model öğesi olduğunu görü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 Interface Control Document koyun.
  3. Şunun için şablonlar altında Arayüz kontrol belgesi'ni seçin, Yazım rehberini dahil et'i işaretleyin, Arayüz kontrol belgesi (ICD) kartını seçin ve Oluştur'a tıklayın.
  4. 2.3 Interface Owners and Change Authority bölümünü seçin ve rehberini okuyun. Açıklamasına tıklayın, rehberi EO-1 arayüzlerinin sahipleriyle (örneğin Payload Lead ve Comms Lead) değiştirin ve kaydetmek için ⌘ / Ctrl↵'a basın.
  5. 3.2 Interface Matrix bölümünü seçin ve şablonun oraya yerleştirdiği canlı arayüz matrisini okuyun.
  6. Denetimli bir adım adım anlatım için 11 Produce the Deliverable öğreticisini çalıştırın (Yardım → Öğreticiler).

Yeni ICD, 2.3'te rehber yerine kendi metninizi ve 3.2'de EO-1 bileşenlerinin bir matrisini gösterdiğinde işiniz bitmiştir.

Kendinizi sınayın

  1. Yeni belge'nin önce hangi şablonları sunacağını ne belirler?
  2. Yazım rehberli ve rehbersiz bir şablon arasındaki fark nedir?
  3. Her bölümün bir model öğesi olması neden önemlidir?
Yanıtları göster
  1. Yeni belge'nin önce hangi şablonları sunacağını ne belirler?

    Şunun için şablonlar altında seçilen belge türü. Diğer türlerin şablonları yine Diğer şablonlar altında listelenir; belge, seçtiğiniz şablonun türünü alır.

  2. Yazım rehberli ve rehbersiz bir şablon arasındaki fark nedir?

    İkisi de aynı numaralı bölümleri ve başlangıç tablolarını verir. Rehberli şablonda her bölüm ayrıca neleri içermesi gerektiğine dair kısa bir rehberle başlar; siz yazdıkça onu değiştirirsiniz.

  3. Her bölümün bir model öğesi olması neden önemlidir?

    Bir bölüm bir Statement'tır; bu yüzden onu bir gereksinim gibi bağlayabilir, yorumlayabilir ve temel çizgiye alabilirsiniz; belge de modelin bir görünümü olarak kalır.

Daha fazla bilgi

Döküm

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

Introduction

Welcome to track four: documents and deliverables. Programs are reviewed through their documents: plans, specifications, and the matrices reviewers ask for. In Holarch, these are built from the model. This first chapter covers document templates.

You will pick a document type and its template, compare an outline with a template that has guidance, and write your own text over that guidance.

Choose a type

We continue with the Bike-Share Dock. It already has requirements, functions, parts and test cases. Open Needs and Requirements, then Documents, and click New Document.

On screen: Needs & Requirements → Documents → + New Document.

The type decides which templates are offered. Holarch has templates for the documents most programs write, from the concept of operations to the test plan, and for the concept stage: needs analysis, concept exploration and concept definition.

On screen: Card: document types with templates.

Name it Bike-Share Dock SEMP. Then, under Templates for, choose Systems Engineering Management Plan Document.

On screen: Name, then Templates for ▾ → Systems Engineering Management Plan Document.

Outline or guidelines

Each template comes in two forms. The outline has only the section headings. With writing guidance, every section also explains what it should hold, with an example. Tick Include writing guidance, choose the template, and click Create.

On screen: Include writing guidance → the template card → Create.

The plan opens with fifteen numbered sections: the life cycle, the technical reviews, requirements management, baselines, interfaces, verification, risk, and the tools and model.

On screen: The new plan and its outline.

Write your plan

Click section 2.1, Purpose. Its text is the guidance: state why this plan exists and who uses it, followed by an example.

On screen: Outline → 2.1 Purpose.

Replace the guidance with your own text. Click the description to edit it, select its text, and type the purpose of this plan. Then press Command Return to save it.

On screen: Edit 2.1's description → type → Save.

The guidance often points to where the work lives in Holarch. Section 8.1, Baselines, says to use Holarch baselines, so that later changes can be compared against them. Chapter four of this track shows how.

On screen: Outline → 8.1 Baselines.

Every section is a model item, a statement, so you can link it, comment on it and baseline it, like a requirement.

On screen: 8.1's class badge: Statement.

Recap

Let's recap. You chose a document type and its template, picked the template with guidelines, read the guidance in a section, and replaced it with your own text.

Next, you put live traceability and verification matrices into a document.