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.