Holarch

הדרכה · מסלול 4. מסמכים ותוצרים

מסלול 4. מסמכים ותוצרים: דף תרגילים

למהנדסים ולראשי צוותים. משימת תרגול אחת וכמה שאלות לכל פרק, לעבודה אחרי כל סרטון. אפשר להדפיס את הדף מהדפדפן או לעבוד על המסך. מפתח התשובות מתחיל בעמוד חדש בסוף.

לפני שמתחילים

מומלץ קודם
פרק 1.5 מסמכים; מסלולים 2 ו-3 הופכים את המטריצות לשימושיות יותר.
תוכנית
Free
פרויקט
Bike-Share Dock: לכל פרק יש קובץ התחלה משלו.

4.1 תבניות מסמכים

צפייה בפרק 4.1 (2:54)

תרגול

על פרויקט ההדגמה 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. למה חשוב שכל סעיף הוא פריט מודל?

4.2 מטריצות חיות במסמכים

צפייה בפרק 4.2 (2:48)

תרגול

על פרויקט ההדגמה CubeSat EO-1:

  1. פותחים את פרויקט ההדגמה EO-1, או יוצרים אותו: ניהול פרויקטים ← קובצי פרויקט ▾ ← פרויקט הדגמה חדש ← CubeSat (הנדסת מערכות מודרכת).
  2. פותחים את צרכים ודרישות ← מסמכים ← EO-1 System Requirements Specification ולוחצים על התיאור של הסעיף 2 Attitude Determination and Control כדי לערוך אותו.
  3. בסרגל הכלים של הטקסט העשיר פותחים את + ובוחרים מטריצה…. בוחרים מטריצת הקצאת דרישות, משאירים את ההיקף על המסמך הזה, לוחצים על הוספה ולוחצים ⌘ / Ctrl↵ כדי לשמור.
  4. קוראים את הכיתוב ואת השורות המוצללות. 2.5 Safe Mode Recovery הוא פער: דבר אינו מקיים אותו.
  5. בוחרים את 2.5, ובקטע עקיבות שלה מקשרים את F10 Enter Safe Mode תחת satisfied by. חוזרים לסעיף 2 וקוראים שוב את המטריצה.

סיימתם כששורת 2.5 של מטריצת ההקצאה מפרטת את F10 Enter Safe Mode וכבר אינה מוצללת.

שאלות

  1. במה מטריצה חיה שונה מטבלה שמקלידים?
  2. למה סוגרים פער במודל ולא במטריצה?
  3. אילו היקפים מטריצה יכולה לכסות?

4.3 פלט Word ו-Excel

צפייה בפרק 4.3 (2:10)

תרגול

על פרויקט ההדגמה CubeSat EO-1:

  1. פותחים את פרויקט ההדגמה EO-1, או יוצרים אותו: ניהול פרויקטים ← קובצי פרויקט ▾ ← פרויקט הדגמה חדש ← CubeSat (הנדסת מערכות מודרכת).
  2. פותחים את EO-1 System Requirements Specification ובוחרים מסירה ▾ ← הגדרת עמוד…. תחת סימון בוחרים סימון משלו ומגדירים כותרת עליונה ותחתונה כמו EO-1 Program Internal.
  3. מסמנים עמוד שער עם גרסה 2.0 ו-הוכן על ידי EO-1 Systems Team, מסמנים מספרי עמודים ולוחצים על החלה.
  4. בוחרים מסירה ▾ ← עותק לסקירה (Word) ופותחים את הקובץ: עמודים לרוחב עם עמודות המאפיינים מתחת לכל פריט, והסימון בכל עמוד.
  5. בוחרים מסירה ▾ ← מטריצת עקיבות…. בוחרים את RVTM, מגדירים את מודל ל-SRR Baseline ואת ייצוא בתור ל-מטריצה (Excel), קוראים את מספר השורות והפערים ולוחצים על ייצוא.

סיימתם כשיש בידיכם קובץ Word עם עמוד השער, הסימון ומספרי העמודים, ו-RVTM ב-Excel של SRR Baseline עם הפערים מוצללים.

שאלות

  1. באיזה סימון מסמך משתמש?
  2. מה ההבדל בין תבנית Word לתבנית מסמך?
  3. מאיפה מגיעות הטבלאות Revision History ו-Approvals בייצוא ל-Word?
  4. למה לייצא מטריצה מקו בסיס ולא מהמודל הנוכחי?

4.4 חבילות סקירה וקווי בסיס

צפייה בפרק 4.4 (2:35)

תרגול

על פרויקט ההדגמה CubeSat EO-1:

  1. פותחים את פרויקט ההדגמה EO-1, או יוצרים אותו: ניהול פרויקטים ← קובצי פרויקט ▾ ← פרויקט הדגמה חדש ← CubeSat (הנדסת מערכות מודרכת). המשימה הזו משתמשת גם ב-EO-1 Interface Control Document מהפרק “תבניות מסמכים”; אם דילגתם על הפרק הזה, יש ליצור אותו קודם.
  2. פותחים את EO-1 System Requirements Specification, לוחצים על בקשת סקירה ליד סוג המסמך, משאירים את כולם לא מסומנים ולוחצים על בקשת סקירה. הרצועה שמתחת לכותרת מציגה את הסקירה.
  3. לוחצים על גרסה ▾ ← שמירת קו בסיס…, נותנים לו את השם PDR Baseline, ממלאים את התפקיד שלכם, לוחצים על + הוספת מאשר לגורם מאשר שני ולוחצים על יצירה.
  4. משנים את 2.4 Target Slew ל-45 שניות. אחר כך בוחרים גרסה ▾ ← השוואת גרסאות… עם מ- PDR Baseline ו-אל הגרסה הנוכחית, ולוחצים על שינויים (Excel).
  5. פותחים את בקרה וסקירות ← סקירות, לוחצים על + חבילת סקירה חדשה ונותנים לה את השם PDR review package. בוחרים כתיבה ▾ ← הוספה ▸ מסמך… פעמיים כדי להוסיף את ה-SRS ואת ה-ICD.
  6. בוחרים מסירה ▾ ← הגדרת התוצר… ומגדירים את ייצוא כל חלק מתוך ל-PDR Baseline עבור חלק ה-SRS, ואז בוחרים מסירה ▾ ← מפרט (Word).

סיימתם כשדוח השינויים מפרט את העריכה ב-2.4 ולקובץ ה-Word של החבילה יש Part A ו-Part B, עם חלק ה-SRS מ-PDR Baseline.

שאלות

  1. מה קו בסיס של מסמך מכיל, והאם הוא יכול להשתנות מאוחר יותר?
  2. במה קו בסיס של מסמך שונה מקו בסיס של פרויקט?
  3. החבילה שלכם צריכה לייצא את ה-SRS שבקו הבסיס, לא את העריכות של היום. איך?
  4. מה קורה לסקירה אחרי שלוחצים על “בקשת סקירה”?

4.5 מצגות מהמודל

צפייה בפרק 4.5 (1:59)

תרגול

על פרויקט ההדגמה CubeSat EO-1:

  1. פותחים את פרויקט ההדגמה EO-1, או יוצרים אותו: ניהול פרויקטים ← קובצי פרויקט ▾ ← פרויקט הדגמה חדש ← CubeSat (הנדסת מערכות מודרכת).
  2. פותחים את תוכנית ← מצגות ולוחצים על + מצגת חדשה. נותנים לה את השם EO-1 PDR Briefing, מגדירים את התחלה מ- ל-מתאר של מסמך עם EO-1 System Requirements Specification, ולוחצים על יצירה.
  3. לוחצים לחיצה כפולה על הכותרת בשקופית הראשונה, מקלידים EO-1 Preliminary Design Review ולוחצים Esc.
  4. לוחצים על + שקופית חדשה ▾, בוחרים ריק, אחר כך תמונה ▾ ← תמונה של… ובוחרים את ה-FFBD של F0 Perform EO-1 Mission.
  5. לוחצים על ▶ הצגה ▾ ← הצגה מהשקופית הנוכחית, מתקדמים עם ← ומסיימים עם Esc. אחר כך לוחצים על ייצוא… ובוחרים מצגת (PowerPoint).

סיימתם כשבמצגת יש שקופית שער, שקופית אחת לכל סעיף של ה-SRS ותמונת FFBD חיה, ויש בידיכם קובץ ה-PowerPoint.

שאלות

  1. מה שומר תמונה בשקופית מעודכנת?
  2. מתי כדאי להתחיל מצגת ממתאר של מסמך?
  3. לאילו פורמטים אפשר לייצא מצגת?

מפתח תשובות

4.1 תבניות מסמכים

  1. סוג המסמך שנבחר תחת “תבניות עבור”. תבניות מסוגים אחרים עדיין מופיעות תחת “תבניות אחרות”; המסמך מקבל את הסוג של התבנית שבוחרים.
  2. שתיהן נותנות אותם סעיפים ממוספרים ואותן טבלאות פתיחה. עם הנחיות, כל סעיף גם מתחיל במדריך קצר למה שהוא אמור להכיל, ואותו מחליפים בזמן הכתיבה.
  3. סעיף הוא Statement, ולכן אפשר לקשר אותו, להעיר עליו ולכלול אותו בקו בסיס כמו דרישה, והמסמך נשאר תצוגה של המודל.

4.2 מטריצות חיות במסמכים

  1. הבלוק שומר רק איזו מטריצה ואיזה היקף להציג. ‏Holarch בונה מחדש את השורות מהמודל בכל פעם שהמסמך מוצג או מיוצא, כך שהוא לעולם אינו מתיישן.
  2. אי אפשר לערוך מטריצה חיה תא אחר תא. הפער הוא קישור או מאפיין שחסרים במודל, ותיקונו שם מעדכן כל מטריצה ותצוגה שמציגה אותו.
  3. הפריטים של מסמך אחד, כל החלקים של מסמך מקובץ, או הפרויקט כולו. מטריצות הממשקים וה-N² יכולות גם לכסות את הילדים של Asset או Action אחד.

4.3 פלט Word ו-Excel

  1. הקרוב ביותר: הסימון של המסמך עצמו, אחרת של הפרויקט, אחרת של הארגון. בלי סימון, המסמך נשאר לא מסומן.
  2. תבנית מסמך ממלאת את התוכן: סעיפים וטבלאות פתיחה. תבנית Word מעצבת את קובץ ה-Word: תוכן עניינים, מספור כיתובים, גודל עמוד וטבלאות של החלק הקדמי.
  3. מקווי הבסיס של המסמך ומרשומות האישור שלהם, כשתבנית ה-Word כוללת אותם, כמו Specification.
  4. ועדת סקירה מסמנת את מה שהוסכם. בחירת קו בסיס תחת “מודל” מייצאת את המטריצה כפי שהייתה בקו הבסיס הזה, לא כפי שהיא היום.

4.4 חבילות סקירה וקווי בסיס

  1. תמונת מצב לקריאה בלבד של המסמך: הפריטים שלו, המאפיינים והקשרים שלהם, והפריטים שנמצאים במרחק קשר אחד. אפשר לשנות את שמו ולהוסיף אישורים, אבל אי אפשר לערוך רשומות אישור קיימות.
  2. קו בסיס של מסמך מכיל מסמך אחד ונשמר מתפריט גרסה ▾ שלו. קו בסיס של פרויקט מכיל כל פריט בפרויקט ונשמר עם + שמירת קו בסיס… בדף בקרה וסקירות ← קווי בסיס וגרסאות.
  3. בחבילה, מגדירים את “ייצוא כל חלק מתוך” לקו הבסיס הזה בחלון הגדרת התוצר…. חלק מוצמד מציג 📌 ואת שם קו הבסיס, ומייצא את התוכן של קו הבסיס.
  4. המסמך בסקירה. הסוקרים של הפרויקט, או האנשים שציינתם, מקבלים אותו תחת “מסמכים לסקירה” בדף העבודה שלי, ומאשרים או דוחים אותו שם או ברצועה שמתחת לכותרת.

4.5 מצגות מהמודל

  1. תמונה שנוצרה עם “תמונה של…” מציגה תצוגה של המודל, לא עותק. כשהדיאגרמה, המסמך או התרשים משתנים, השקופית מציגה את השינוי.
  2. כשהתדריך עוקב אחר מסמך: מקבלים שקופית שער ועוד שקופית אחת לכל סעיף עליון עם טקסט הסעיף, מוכנות לקיצוץ.
  3. PowerPoint, ‏Word ודף אינטרנט עבור המצגת כולה, ו-PNG או SVG עבור השקופית הנוכחית.

פורסם על ידי Holarch