פרקי הקורס
הדרכה · מסלול 1. תחילת עבודה · פרק 1.5 מתוך 8
1.5 מסמכים 2:46
כותבים מפרט שהדרישות שלו הן פריטי מודל.
מציג את Holarch 1.27.
מה תלמדו
- ליצור מפרט דרישות מתבנית מובנית
- להוסיף דרישה תחת סעיף ולכתוב את משפט ה-shall שלה
- להוסיף כמה דרישות במהירות עם “הוספה מהירה”
- למצוא את הדרישות של מסמך במסד הנתונים כפריטי מודל
- לייצא את המפרט ל-Word מתפריט המסירה
יוצרים את מפרט דרישות המערכת של Bike-Share Dock מתבנית מובנית, כותבים דרישה תחת סעיף עם “+ צאצא” ועם חלונית המאפיינים, מוסיפים עוד עם “הוספה מהירה”, רואים שכל דרישה במסמך היא פריט מודל במסד הנתונים, ומייצאים את המסמך ל-Word.
קובצי פרויקט
- פרויקט התחלה (.holarch.json; ניהול פרויקטים ← קובצי פרויקט ▾ ← ייבוא פרויקט (.json)…)
- פרויקט גמור (.holarch.json; ניהול פרויקטים ← קובצי פרויקט ▾ ← ייבוא פרויקט (.json)…)
הסרטון מוצג מ-holarch.app; ראו את מדיניות הפרטיות.
תרגול
עשו זאת בעצמכם ב-Holarch, על פרויקט ההדגמה CubeSat EO-1.
- פותחים את פרויקט ההדגמה EO-1 (או יוצרים אותו: ניהול פרויקטים ← קובצי פרויקט ▾ ← פרויקט הדגמה חדש ← CubeSat (הנדסת מערכות מודרכת)).
- פותחים את צרכים ודרישות ← מסמכים ולוחצים על + מסמך חדש. נותנים לו את השם
EO-1 Ground Station Specification, בוחרים את התבנית מפרט דרישות ולוחצים על יצירה. - בוחרים את הסעיף 4.1 Primary Functions, לוחצים על + צאצא, נותנים לדרישה את השם
Track the Spacecraftוכותבים את משפט ה-shall שלה בתיאור שבחלונית המאפיינים. - בהוספה מהירה שבתחתית בוחרים תחת 10 Design Constraints, מקלידים
The ground station antenna shall have a diameter of no more than 3.7 m.ולוחצים Enter. מוסיפים אילוץ שני באותה דרך. - פותחים את מסד הנתונים ומקלידים
in:"EO-1 Ground Station Specification" class:Requirementבתיבת החיפוש כדי להציג את הדרישות החדשות. - חוזרים למסמך, בוחרים מסירה ▾ ← מפרט (Word) ופותחים את הקובץ.
סיימתם כשקובץ ה-Word מציג את שלוש הדרישות שלכם תחת הסעיפים הממוספרים שלהן.
בדיקה עצמית
- מה ההבדל בין דרישה שמוקלדת במסמך של Holarch לבין דרישה שמוקלדת במעבד תמלילים?
- איך “הוספה מהירה” בוחרת את השם של הדרישה החדשה?
- מתי כדאי לסמן “הכללת הנחיות כתיבה”?
הצגת התשובות
מה ההבדל בין דרישה שמוקלדת במסמך של Holarch לבין דרישה שמוקלדת במעבד תמלילים?
ב-Holarch כל דרישה במסמך היא פריט מודל: אפשר ליצור לה עקיבות, לבדוק את האיכות שלה, לצייר אותה בדיאגרמות ולמצוא אותה במסד הנתונים.
איך “הוספה מהירה” בוחרת את השם של הדרישה החדשה?
היא נותנת לדרישה שם מהמילים שאחרי shall וממספרת אותה אחרי האחיות שלה בסעיף שנבחר.
מתי כדאי לסמן “הכללת הנחיות כתיבה”?
כשהכותבים חדשים בסוג המסמך: כל סעיף מקבל אז הערה קצרה על מה שהוא אמור להכיל, ואותה מוחקים בזמן הכתיבה.
קריאה נוספת
תמליל
הצגת התמליל (הקריינות ומה שמוצג על המסך)
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.