Holarch
فصول الدورة

التدريب · المسار 4. المستندات والمخرجات · الفصل 4.1 من 5

4.1 قوالب المستندات 2:54

ابدأ خطة أو مواصفة من قالب، مع إرشادات لكل قسم.

يعرض Holarch 2.13.

كل الفصول · 4.2 المصفوفات الحية في المستندات ←

ما ستتعلمه

  • أنشئ مستندًا من نوع مختار من قالب مدمج
  • ضمّن إرشادات الكتابة واقرأ الإرشادات في قسم
  • استبدل إرشادات قسم بنصك الخاص واحفظه
  • اشرح لماذا يكون كل قسم في المستند عنصرًا في النموذج

أنشئ خطة إدارة هندسة النظم لـ Bike-Share Dock من قالب مدمج: اختر نوع المستند، وقارن المخطط التفصيلي بالقالب الموجَّه، واقرأ الإرشادات في كل قسم، واستبدلها بنصك الخاص، ولاحظ أن كل قسم عنصر في النموذج.

ملفات المشاريع

  • مشروع البداية (.holarch.json؛ إدارة المشاريع ← ملفات المشروع ▾ ← استيراد مشروع (.json)…)
  • المشروع المكتمل (.holarch.json؛ إدارة المشاريع ← ملفات المشروع ▾ ← استيراد مشروع (.json)…)

يُشغَّل الفيديو من holarch.app؛ راجع سياسة الخصوصية.

التطبيق العملي

نفّذ هذا بنفسك في Holarch، على المشروع التوضيحي CubeSat EO-1.

  1. افتح مشروع EO-1 التوضيحي الخاص بك، أو أنشئه: إدارة المشاريع ← ملفات المشروع ▾ ← مشروع توضيحي جديد ← CubeSat (هندسة أنظمة موجّهة).
  2. افتح الاحتياجات والمتطلبات ← المستندات وانقر + مستند جديد. وسمّه EO-1 Interface Control Document.
  3. تحت القوالب لـ، اختر وثيقة التحكم في الواجهة، وحدّد تضمين إرشادات الكتابة، واختر بطاقة وثيقة التحكم في الواجهة (ICD) وانقر إنشاء.
  4. حدّد القسم 2.3 Interface Owners and Change Authority واقرأ إرشاداته. انقر وصفه، واستبدل الإرشادات بمالكي واجهات EO-1 (مثل Payload Lead وComms Lead)، واضغط ⌘ / Ctrl↵ للحفظ.
  5. حدّد القسم 3.2 Interface Matrix واقرأ مصفوفة الواجهات الحية التي وضعها القالب هناك.
  6. لجولة مفحوصة خطوة بخطوة، شغّل البرنامج التعليمي 11 Produce the Deliverable (التعليمات ← البرامج التعليمية).

تنتهي حين تعرض وثيقة ICD الجديدة نصك الخاص في 2.3 بدلًا من الإرشادات، ويعرض 3.2 مصفوفة لمكونات EO-1.

اختبر نفسك

  1. ما الذي يحدد القوالب التي يعرضها «مستند جديد» أولًا؟
  2. ما الفرق بين قالب مع إرشادات الكتابة وقالب بدونها؟
  3. لماذا يهم أن يكون كل قسم عنصرًا في النموذج؟
إظهار الإجابات
  1. ما الذي يحدد القوالب التي يعرضها «مستند جديد» أولًا؟

    نوع المستند المختار تحت «القوالب لـ». وتبقى قوالب الأنواع الأخرى مدرجة تحت «قوالب أخرى»؛ ويأخذ المستند نوع القالب الذي تختاره.

  2. ما الفرق بين قالب مع إرشادات الكتابة وقالب بدونها؟

    يعطي كلاهما الأقسام المرقّمة نفسها والجداول المبدئية نفسها. ومع الإرشادات، يبدأ كل قسم أيضًا بدليل قصير لما يجب أن يحتويه، تستبدله أثناء الكتابة.

  3. لماذا يهم أن يكون كل قسم عنصرًا في النموذج؟

    القسم Statement، فيمكنك ربطه والتعليق عليه وإدراجه في خط أساس مثل المتطلب، ويبقى المستند طريقة عرض للنموذج.

قراءة المزيد

النص المكتوب

إظهار النص المكتوب (التعليق الصوتي وما يظهر على الشاشة)

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.