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.