דרישות
הפקת מסמכים
הכנסת מטריצות חיות של עקיבות, אימות וממשקים ודוחות בדיקה למסמכים, ייצואם בארבעה פורמטים, בנייתם מקו בסיס וסימונם: הודעת חברה, הצהרת הפצה של DoD, הודעת בקרת יצוא, זכויות יוצרים או מספר חוזה בכל עמוד ובכל ייצוא.
בדף זה
סקירה כללית
Holarch בונה תוצרים מהמודל, כך שמסמך תמיד תואם לדרישות, לבדיקות ולקישורים שמאחוריו. שלושה כלים מכסים את מה שסוקרים מבקשים בדרך כלל:
- גושי מטריצה: מטריצת עקיבות, אימות או ממשקים, או דוח בדיקה, בתוך הטקסט של מסמך, שמתעדכנים בכל פעם שהמודל משתנה.
- ייצוא המטריצה: אותן מטריצות ודוח הבדיקה כקובץ נפרד ב-Excel, Word, CSV או כדף אינטרנט, מהמודל הנוכחי או מקו בסיס.
- סימונים והגדרת עמוד: סימון לארגון, לפרויקט או למסמך אחד (הודעת חברה, הצהרת הפצה, הודעת פיקוח יצוא, זכויות יוצרים או מספר חוזה) בכל ייצוא, וגם עמוד שער ומספרי עמודים ל-Word.
ערכים וטבלאות חיים בטקסט מוסברים בדף מסמכים: ערך חי… מכניס מאפיין אחד של ישות, ספירה או סכום… מספר שמחושב משאילתה, טבלה חיה… טבלה משאילתה, ו-הפניה צולבת… את המספר הנוכחי של סעיף, איור או טבלה.
מושגים
המטריצות
| מטריצה | שורות | עמודות | מודגש כפער |
|---|---|---|---|
| RTM (מטריצת עקיבות דרישות) | דרישות | Number, Requirement, Parent, Traced From, Traced To, Satisfied By | דרישה בלי הורה ובלי דבר שהיא נגזרת ממנו (traces from) |
| מטריצת זרימת דרישות כלפי מטה | דרישות | Number, Requirement, Flows Down From, Flows Down To, Derived Requirements | דרישה ברמה העליונה בלי צאצא ובלי דרישה נגזרת |
| מטריצת הקצאת דרישות | דרישות | Number, Requirement, Components, Functions, Other | דרישה ששום דבר לא מספק |
| מטריצת תאימות (מוצגת כשהתוכנית הרשמית פעילה) | דרישות של מפרט לקוח | Number, Requirement, Compliance, Response, Our Requirements and Design, Verification, Deviation/Waiver | דרישה בלי הצהרת תאימות (Not assessed) |
| RVTM (מטריצת עקיבות לאימות דרישות) | דרישות | Number, Requirement, Method, Level, Verified By, Status | אין שיטת אימות או אין מקרה בדיקה שמאמת |
| VCRM (מטריצת הפניות צולבות לאימות) | דרישות | Number, Requirement, Inspection, Analysis, Demonstration, Test, Verified By, Status | לא נבחרה שיטת אימות |
| VCRM לפי רמת אימות | דרישות | Number, Requirement, ואחריהן I, A, D ו-T תחת כל רמת אימות, Verified By, Status | אין שיטת אימות או אין רמת אימות |
| דוח בדיקה | מקרי בדיקה של מחזור בדיקה | Number, Test Case, Verifies, Status, Actual Result, Run | מקרה בדיקה שלא עבר במחזור |
| מטריצת הקצאה | פונקציות (Actions) | Number, Function, Performed By | פונקציה שאף רכיב לא מבצע |
| מטריצת ממשקים | רכיבים (Assets) | אותם רכיבים; תא מציג את ה-Conduit-ים מרכיב השורה לרכיב העמודה | רכיב בלי Conduit אל הרכיבים האחרים או מהם |
| מטריצת N² | פונקציות (Actions) | אותן פונקציות; תא מציג את ה-Input/Output-ים שפונקציית השורה מפיקה ופונקציית העמודה מקבלת | פונקציה שלא מחליפה שום קלט או פלט |
| מטריצה מותאמת | ישויות משאילתת חיפוש | ישויות משאילתה שנייה; תא נותן את שמות הקשרים בין השתיים, או מציג X לקשר אחד שנבחר | שורה בלי קשר לאף עמודה |
- Parent היא הדרישה שהשורה decomposes. Traced From, Traced To ו-Satisfied By מציגות את הישויות הקשורות. במטריצת הזרימה כלפי מטה, Derived Requirements הן הדרישות שהשורה traces to.
- ב-VCRM X מסמן כל שיטה מתוכננת; Status היא תוצאת האימות עד כה, שמסוכמת ממקרי הבדיקה כמו במרכז הבדיקות.
- ב-VCRM לפי רמת אימות, העמודות מקובצות לפי הרמות של המאפיין רמת אימות (Component, Subsystem, System). X מופיע תחת הרמה של הדרישה ותחת כל אחת מהשיטות המתוכננות שלה.
- מקרי בדיקה אף פעם לא מוצגים כפונקציות: מטריצות ההקצאה וה-N² מציגות Actions שאינם Test Cases.
- היקף: מטריצה מכסה את הישויות של מסמך אחד (בסדר ובמספור של המסמך), את כל החלקים של קובץ מאוגד, או את הפרויקט כולו. מטריצת ההקצאה משתמשת בפונקציות של המסמך, או בכל הפונקציות כשאין במסמך פונקציות. מטריצות הממשקים וה-N² יכולות גם לכסות את הצאצאים של Asset או Action אחד, כמו דיאגרמות I² ו-N²; לפרויקט כולו הן מציגות את הרכיבים או הפונקציות שיש להם Conduit או Input/Output, עד 120. המטריצה המותאמת מציגה עד 2,000 שורות ו-120 עמודות.
- גוש דוח בדיקה מציג מחזור בדיקה אחד של חבילת בדיקות אחת, או את התוצאות הנוכחיות שלה. ראו דוחות בדיקה.
חיות, לא מועתקות
גוש מטריצה שומר רק את מה שיש להציג, לא את השורות. בכל פעם שהמסמך מוצג או מיוצא, Holarch בונה מחדש את השורות מהמודל. התוצאה נשמרת במטמון עד השינוי הבא, כך שפרויקטים גדולים נשארים מהירים.
איך להשתמש בה
הוספת מטריצה למסמך
- יש לפתוח את המסמך וללחוץ בתוך התיאור של המסמך או של פריט.
- בסרגל הכלים של הטקסט העשיר יש לפתוח את + ולבחור מטריצה….
- יש לבחור את מטריצה ואת היקף. ההיקף מתחיל במסמך הפתוח.
- למטריצה מותאמת יש להזין את שאילתות החיפוש של שורות ושל עמודות (למשל
class:Requirementו-class:Asset), לבחור קשר או להשאיר כל קשר, ואם רוצים לתת לה כותרת. - לדוח בדיקה יש לבחור את חבילת בדיקות ואת מחזור הבדיקה, או תוצאות נוכחיות.
מוצגת תצוגה מקדימה. היא מתעדכנת בכל פעם שהמודל משתנה.
- למטריצה מותאמת יש להזין את שאילתות החיפוש של שורות ושל עמודות (למשל
- יש ללחוץ על הוספה.
המטריצה מופיעה בטקסט עם קו מתאר מקווקו. הכיתוב שלה נותן את שם המטריצה, את ההיקף ואת מספר השורות שיש בהן פערים.
אי אפשר לערוך את המטריצה תא אחר תא; במקום זאת משנים את המודל. כדי להסיר אותה, מוחקים את הטבלה בעורך כמו כל תוכן אחר.
ייצוא מטריצה
- במסמך יש לפתוח את מסירה ▾ ולבחור מטריצת עקיבות…. או לבחור מסירה ▾ → כל הייצואים… ואז מטריצת עקיבות (Excel), (Word), (CSV) או (HTML).
- ב-ייצוא המטריצה יש לבחור את מטריצה ואת היקף, וב-ייצוא בתור לבחור מטריצה (Excel), מטריצה (Word), מטריצה (CSV) או מטריצה (HTML).
- אופציונלי: ב-מודל אפשר לבחור קו בסיס במקום המודל הנוכחי. הרשימה מציגה את קווי הבסיס של הפרויקט ואת אלה של המסמך שנבחר.
השורה שמתחת לשדות נותנת את מספר השורות ואת מספר השורות שיש בהן פערים.
- יש ללחוץ על ייצוא.
ההודעה הקופצת היא "המטריצה יוצאה." פערים מוצללים באדום ב-Excel, ב-Word ובדף האינטרנט. ייצואי Word ודף אינטרנט משתמשים בהגדרת העמוד של המסמך. ב-Word עמודות הטקסט רחבות ועמודות שיטות האימות צרות, עם הכותרות I, A, D ו-T ומקרא מתחת לטבלה (I = Inspection, A = Analysis, D = Demonstration, T = Test). מטריצות עם יותר מחמש עמודות משתמשות בעמוד לרוחב. ל-VCRM לפי רמה יש שורת כותרת שנייה עם הרמות; מטריצות ממשקים, N² ומותאמות מצלילות את כותרות השורות ואת האלכסון.
מטריצות מקו בסיס
תוצר חתום חייב להציג את המודל כפי שהיה כשנקבע קו הבסיס, לא כפי שהוא היום. מטריצה שנבנית מקו בסיס משתמשת בישויות ובקשרים של קו הבסיס, והכותרת שלה מסתיימת ב-"(קו בסיס שם)".
- ייצוא המטריצה: יש לבחור את קו הבסיס ב-מודל.
- קו בסיס של פרויקט מכיל את כל המודל, ולכן כל מטריצה עובדת ממנו.
- קו בסיס של מסמך מכיל את המסמך, את הפריטים שלו ואת הישויות שמקושרות אליהם. המטריצות של המסמך הזה שלמות. מטריצה שחורגת מהמסמך (הפרויקט כולו, או מטריצת ממשקים או N²) נושאת את ההערה "נבנתה מקו בסיס של מסמך, שמכיל רק את המסמך הזה ואת הישויות שמקושרות אליו."
דוחות בדיקה
דוח בדיקה נותן את התוצאות של מחזור בדיקה אחד: מה נבדק, באיזו תצורה, מה עבר ומה נכשל, ואילו דרישות זה מאמת.
- במרכז הבדיקות מתעדים מחזור בדיקה עם התחלת מחזור חדש…. יש להזין את תצורה / גרסת בנייה ואת פריט הבדיקה (שניהם מתחילים בערכים שתועדו בהרצה בתדירות הגבוהה ביותר).
- בכרטיס החבילה יש לפתוח את ⋯ ולבחור דוח בדיקה…. או לפתוח את ⋯ → מחזורי בדיקה… וללחוץ על דוח… במחזור.
- ב-ייצוא דוח הבדיקה יש לבחור את מחזור הבדיקה, וב-ייצוא בתור את דוח בדיקה (Word), (Excel), (CSV) או (HTML), ואז ללחוץ על ייצוא.
לדוח ה-Word (ברירת המחדל) יש המקטעים האלה:
- זיהוי: חבילת הבדיקות, מחזור הבדיקה, מתי נשמרו התוצאות ומתי הופק הדוח.
- סביבת בדיקה ותצורה: תצורה או גרסת בנייה, פריט בדיקה, בודקים ותאריכי הרצה.
- סיכום התוצאות: ספירות לפי סטטוס ושיעור ההצלחה.
- תוצאות לפי מקרה בדיקה: שורה אחת לכל מקרה בדיקה.
- תוצאות מפורטות: לכל מקרה בדיקה, התוצאה הצפויה והתוצאה בפועל, הבודק, התאריך, התצורה, פריט הבדיקה, קובץ הראיות ותוצאות הצעדים.
- חריגות ובעיות פתוחות: מקרי בדיקה שנכשלו או נחסמו, עם ה-Issues המקושרים שלהם.
- ראיות בדיקה: קובצי הראיות שתועדו במחזור.
- סטטוס אימות הדרישות: הדרישות שהחבילה מאמתת, עם הסטטוס שלהן מהתוצאות של המחזור הזה.
Excel נותן שלושה גיליונות (Results, Steps, Requirements); CSV ודף האינטרנט נותנים את טבלת התוצאות. התוצאות באות מהמחזור כפי שנשמר, ולכן הדוח נשאר זהה אחרי איפוס החבילה. שמות, דרישות מאומתות ו-Issues באים מהמודל הנוכחי. מחזורים שנשמרו לפני שתוצאות צעדים וראיות נשמרו מציגים את השדות האלה כ-"—".
כדי להכניס את טבלת התוצאות למסמך, מוסיפים גוש מטריצה של דוח בדיקה (ראו למעלה).
סימון מסמכים וייצואים
סימון הוא טקסט ש-Holarch מדפיס על כל מה שמייצאים: כותרת עליונה בראש כל עמוד, כותרת תחתונה בתחתית כל עמוד והודעה בעמוד הראשון. מגדירים אותו פעם אחת לפרויקט, או לארגון, וכל ייצוא נושא אותו. מסמך יכול להחליף אותו בסימון משלו.
הערה: השירות המתארח (app.holarch.app) לא יכול להכיל מידע CUI, מסווג או בפיקוח יצוא (תנאי השימוש). שם הרשימה הסטנדרטית לא כוללת את Distribution Statements B עד F ואת הודעת פיקוח היצוא, וסימון שמזכיר CUI, רמת סיווג (כמו SECRET//NOFORN), ITAR, EAR או פיקוח יצוא, או את Distribution Statements B עד F לא נשמר: "השירות המתארח של Holarch לא יכול להכיל מידע CUI, מסווג או בפיקוח יצוא, ולכן אי אפשר להשתמש כאן בסימון הזה. יש להסיר אותו, או להשתמש באפליקציית שולחן העבודה או בהתקנה באירוח עצמי." הודעות חברה כמו Company Confidential, Distribution Statement A, זכויות יוצרים ומספרי חוזה נשארים זמינים. סימונים שהוגדרו לפני הכלל הזה נשמרים ועדיין מודפסים; כדי לשנות סימון כזה, יש להסיר את החלק המוגבל.
אפליקציית שולחן העבודה והתקנות באירוח עצמי מציעות את כל הרשימה ומקבלות כל סימון. סימונים הם טקסט שבוחרים; Holarch מדפיס אותם אבל לא אוכף כללי טיפול, והבקרות של הארגון שלך חלות. בכל מהדורה, הודעת פיקוח יצוא בסימון מכבה את ה-AI בפרויקט.
הרשימה סימון תקני ממלאת את הטקסט בשבילך:
| סימון תקני | כותרת | כותרת תחתונה | הודעה |
|---|---|---|---|
| Company Proprietary | COMPANY PROPRIETARY | COMPANY PROPRIETARY | הודעת קניין שמזכירה את חברה |
| Company Confidential | COMPANY CONFIDENTIAL | COMPANY CONFIDENTIAL | הודעת סודיות שמזכירה את חברה |
| Distribution Statement A עד F (B עד F: רק באפליקציית שולחן העבודה ובאירוח עצמי) | (אין) | DISTRIBUTION STATEMENT A to F | הנוסח הסטנדרטי של DoD להצהרה (DoDI 5230.24), עם סיבה, תאריך הקביעה ו-המשרד האחראי ממולאים |
| הודעת פיקוח יצוא (ITAR/EAR) (רק באפליקציית שולחן העבודה ובאירוח עצמי) | (אין) | Export-controlled technical data. See the notice on the first page. | אזהרה שהמסמך עשוי להכיל מידע טכני לפי ITAR (22 CFR 120–130) או EAR (15 CFR 730–774) |
| זכויות יוצרים | (אין) | © שנה בעל זכויות היוצרים. All rights reserved. | (אין) |
| מספר חוזה | (אין) | Contract No. מספר חוזה | (אין) |
שדה מילוי שמשאירים ריק נשאר בטקסט כמציין מקום בסוגריים מרובעים, כמו [reason]. העורך מציג אז "יש להשלים את החלקים שבסוגריים לפני הייצוא."
הגדרת הסימון של הפרויקט
- יש להקיש ⌘K / Ctrl+K ולבחור סימון הפרויקט…. אפשר גם לפתוח אותו מ-הגדרת עמוד… במסמך, או מ-העדפות הפרויקט… (בית ▾ בדף הבית) של הפרויקט הפתוח.
- יש לבחור סימון משלו.
- ב-סימון תקני יש לבחור רשומה, למלא את השדות שלה (למשל חברה) וללחוץ על הוספה לסימון.
השדות כותרת עליונה, כותרת תחתונה ו-הודעה מוצגים ממולאים. אפשר להוסיף רשומה נוספת כדי לשלב ביניהן: כותרות עליונות ותחתונות מחוברות ב-" · ", וכל הודעה הופכת לפסקה נפרדת.
- אפשר לערוך את הטקסט לפי הצורך, ואז ללחוץ על שמירה.
ההודעה הקופצת היא "סימון הפרויקט נשמר." רק בעלי הפרויקט משנים את סימון הפרויקט; חברים אחרים רואים אותו לקריאה בלבד.
ניקוי מרוקן את שלושת השדות. ללא סימון מכבה את הסימון בפרויקט, גם כשלארגון יש סימון.
הגדרת הסימון של הארגון
- יש לפתוח את תפריט החשבון ולבחור הגדרות הארגון, ואז לפתוח את הארגון.
- תחת סימון המסמך יש ללחוץ על עריכת הסימון….
- יש להגדיר את הסימון כמו לפרויקט וללחוץ על שמירה.
ההודעה הקופצת היא "סימון הארגון נשמר." הוא חל על כל פרויקט של הארגון שאין לו סימון משלו. רק מנהלי הארגון משנים אותו.
מתן סימון משלו, עמוד שער ומספרי עמודים למסמך
- במסמך יש לפתוח את מסירה ▾ ולבחור הגדרת עמוד….
- תחת סימון יש לבחור אחת מהאפשרויות:
- סימון הפרויקט או הארגון (ברירת המחדל): השורה שמתחת נותנת את שם הסימון שהמסמך משתמש בו.
- סימון משלו: מגדירים את הכותרת העליונה, הכותרת התחתונה וההודעה כמו לפרויקט.
- ללא סימון: המסמך והייצואים שלו לא נושאים סימון.
- יש למלא את השאר:
- עמוד שער, עם גרסה ו-הוכן על ידי. עמוד השער מציג גם את ההודעה.
- מספרי עמודים ("עמוד X מתוך Y") בייצואי Word.
- יש ללחוץ על החלה.
ההודעה הקופצת היא "הגדרת העמוד נשמרה." הכותרת העליונה והתחתונה מופיעות בראש המסמך ובתחתיתו, וההודעה מתחת לכותרת שלו. ⌘Z / Ctrl+Z מבטל את השינוי בצעד אחד.
הסימון הקרוב ביותר גובר: של המסמך עצמו, אחרת של הפרויקט, אחרת של הארגון.
היכן הסימונים מודפסים
- תצוגת מסמך ו-הדפסה או PDF…: הכותרת העליונה והתחתונה בראש כל עמוד ובתחתיתו, וההודעה מתחת לכותרת.
- ייצוא ה-Word (מסירה ▾ → {template} (Word), או מסמך (Word) ב-כל הייצואים…): הכותרת העליונה והתחתונה חוזרות בכל עמוד, עם מספרי עמודים אם נבחרו, ועמוד השער מחליף את הכותרת הפשוטה. גוש מטריצה חי במסמך הופך לטבלת Word עם הכותרת שלו מעליה, אותם רוחבי עמודות וכותרות I/A/D/T, והפערים שלו מוצללים באדום.
- ייצוא המטריצה ו-מטריצת עקיבות (Word) או (HTML).
- קובצי Word אחרים: מסמך ה-ICD, המצגת, הדיאגרמה וייצואי פירוק (Word) נושאים את הכותרת העליונה והתחתונה בכל עמוד ואת ההודעה מתחת לכותרת.
- דוחות Excel: הכותרת העליונה והתחתונה נכנסות לכותרת העליונה והתחתונה של העמוד בכל גיליון, ש-Excel מציג בתצוגת Page Layout ומדפיס.
- CSV: רק כשמסמנים את סימון כשורה הראשונה ב-טבלה (CSV). האפשרות כבויה כברירת מחדל, כך שאפשר לייבא את הקובץ שוב כמו שהוא.
- תמונות דיאגרמה: ייצואי PNG ו-SVG מקבלים פס מעל הדיאגרמה עם הכותרת העליונה ופס מתחתיה עם הכותרת התחתונה וההודעה. ייצואי דף אינטרנט (HTML) מציגים אותם בראש הדף ובתחתיתו. תמונות ממוזערות ותמונות דיאגרמה בתוך מסמכים נשארות בלי סימון.
- מצגות: שקופיות PowerPoint, דף אינטרנט, PNG ו-SVG מציגות את הכותרת העליונה והתחתונה בכל שקופית ואת ההודעה בשקופית הראשונה.
- לקובץ מאוגד יש הגדרת עמוד משלו, שמשמשת כשמייצאים את הקובץ המאוגד.
בדיקות המודל
בדיקות המודל מדווחות על ערך חי או טבלה חיה שמפנים למשהו שנמחק (הכלל Global.7, "ערכים חיים שמפנים ליעדים חסרים"):
- ערך חי שהישות שלו נמחקה מציג "{Entity: … Not found}".
- גוש מטריצה שמסמך ההיקף שלו נמחק, גוש דוח בדיקה שחבילת הבדיקות או מחזור הבדיקה שלו נמחקו, או מטריצה מותאמת שהקשר שלה כבר לא קיים.
- ספירה או סכום או טבלה חיה שהשאילתה שלהם מזכירה מחלקה, תווית, קשר או מסמך שלא קיימים.
- הפניה צולבת שהפריט, האיור או הטבלה שלה נמחקו.
יש לפתוח את התיאור, ואז לערוך או להסיר את הערך החי, או להוסיף אותו שוב ליעד שקיים. ראו בדיקות המודל.
טיפים
- אפשר לשים את ה-RVTM או ה-VCRM בסוף מפרט כמקטע האימות שלו; הוא נשאר עדכני עד הסקירה.
- לחבילת סקירה בונים קובץ מאוגד ונותנים לו עמוד שער וסימון בהגדרת העמוד שלו.
- אפשר לייצא את ה-VCRM ל-Excel עבור ועדת סקירה שמוסיפה עליו הערות, ולהשאיר את הגוש החי במסמך.
- לתוכנית אימות שמאורגנת לפי רמת אינטגרציה, משתמשים ב-VCRM לפי רמת אימות ומגדירים קודם את רמת אימות של כל דרישה.
- למסמך בקרת ממשקים מוסיפים מטריצת ממשקים שההיקף שלה הוא ה-Asset של המערכת, כך שהצאצאים שלו וה-Conduit-ים שלהם מופיעים על האלכסון ובתאים.