מתחילים כאן
איך קוראים את התיעוד
מפרידים בין מקור, מימוש, הפעלה חיה, טיוטה ותיעוד היסטורי.
בעמוד הזה
מרכז התיעוד שומר את המסמכים המלאים ואת הקשר המקור שלהם. מסמך מפרט מה הוגדר או נבדק במועד כתיבתו. כדי להבין התנהגות נוכחית צריך להצליב גרסה, תחום אחריות, מצב מימוש וראיות הפעלה.
מקור וגרסה#
מרכז התיעוד נבנה על בסיס מסמכי הענף הראשי בגרסה fb427598bb9ea78224f5858bb41b5d386317db9c. בכל פריסה, קישור המקור של מסמכי הענף הראשי מצביע לגרסת הקוד שממנה נבנה האתר. אחת־עשרה תמונות מצב של מסמכי הפיתוח מקורן ב־PR #69, בגרסה 34bdd4e927b8e91dfc6694f277fabcdf2fd360ab. שלוש תמונות מצב נוספות משמרות מסמכי תשתית ובדיקות ייחודיים מ־PR #52 ומ־PR #57; בכל אחת מוצגת גרסת המקור המדויקת שלה. רשומת המקור מאפשרת להבדיל בין מסמך בענף הראשי לבין מסמך שטרם מוזג.
תאריך מקור מוצג רק כאשר הוא ידוע מהמסמך או ממטא־נתוני המקור. תאריך פרסום מרכז התיעוד אינו הופך מסמך ישן למסמך שנבדק מחדש. מסמך ששמו כולל Release או Verification מתאר את הבדיקה או הפריסה המתועדת בו, ולא בדיקת בריאות מתמשכת של השירות.
משמעות המצבים#
| מצב בתיעוד | מה אפשר להסיק | מה נדרש לבדוק בנפרד |
|---|---|---|
foundation | קיימת תשתית בקוד לפי המפרט | השלמת התהליך, חיבורי ספק ואימות סביבת היעד |
demo | קיים תהליך הדגמה | נתוני אמת, סמכות שרת ופעולה אצל הספק |
specified או planned | היכולת הוגדרה | מימוש, בדיקות, הפעלה וקבלה |
available בקטלוג החבילות | הקטלוג מסמן יכולת קיימת | הנתונים וההרשאות הזמינים בחשבון המסוים |
integration | התכולה תלויה בחיבור | מתאם, הסכם, אישורים ובדיקת קצה לקצה |
blocked | שער או תלות פתוחים במקור המתוארך | ראיות מאוחרות שסוגרות את אותו שער |
deployed במסמך מקור | המקור מדווח על פריסה במועדו | הגרסה וההגדרות שמשרתות כעת את הכתובת החיה |
יש לשמור גם על ההבדל בין זכאות מסלול לבין זמינות תפעולית. שורה שכוללת יכולת ב־Enterprise עשויה להיות מסומנת בתכנון או ממתינה לחיבור. הזכאות אינה מחברת ספק או יוצרת SLA בפני עצמה. מטריצת המסלולים מציגה את שני הממדים.
סדר ההעדפה בין מקורות#
- למספרי מחיר, מכסות ועמלות משתמשים בקטלוג המסלולים ובקטלוג התכונות.
- להתנהגות טכנית משתמשים בחוזה המקור ובמסמך העדכני של התחום, עם תאריך וגרסה.
- לתכנון משתמשים במפרטים ובשערי הקבלה, בלי להסיק שהמימוש הושלם.
- למצב פרודקשן נדרשות ראיות פריסה, הגדרות ובדיקות של אותה סביבה. מדריך זה אינו מבצע בדיקת ענן בכל פתיחת דף.
לדוגמה, מחקר ספקי הטעינה כולל הקשר מסחרי מתקופה שבה הופיע קטלוג 1.3.0. שיעור עמלת LinkNodes המאושר נקבע בקטלוג 1.4.0: 0.99% לפני מע״מ בכל המסלולים. המקור המחקרי נשמר כדי שאפשר יהיה לבחון את הראיות, יחד עם אזהרה שהוא אינו המחירון הנוכחי.
מסמכים מלאים, יצוא ומידע שהוסר#
מסמכי המקור מוצגים בגוף הדף, לצד קישור לקובץ ולגרסת המקור. קישור לרפוזיטורי פרטי עשוי לדרוש הרשאה. מראות שנוצרו אוטומטית תחת public/ אינן מוצגות שוב כאשר אותו מסמך כבר כלול תחת docs/.
הפרסום שומר הגדרות סכימה, שמות משתני סביבה, נהלי עבודה ובקרות טכניות. כאשר מסמך כולל ערכי גישה, מזהים תפעוליים או פרטים אישיים שאינם נחוצים להסבר, התצוגה הציבורית מסירה את הערכים ומסמנת את ההסרה. מקור הגרסה נשמר; אין להעתיק לתיעוד סודות או נתוני לקוח כדי להשלים דוגמה.
כשהמקורות אינם מסכימים#
שמרו את ההבדל גלוי: ציינו את המקור והתאריך לכל טענה, ואת הראיה המאוחרת שמעדכנת אותה. ספרי Product, Architecture ו־Data כוללים רשומות מנובמבר 2026 עם מצבי תכנון. מסמכי יכולת מאוחרים עשויים להוסיף מימוש בלי לעדכן את כל הרשומות הישנות. אין להפוך מונה שערים היסטורי להצהרה גורפת על המוצר היום.
רשומות התשתית מאירופה#
מצב המעבר מ־20 בנובמבר מעדכן את שער המעבר מ־11 בנובמבר. שני המסמכים שייכים לטיוטת תשתית היסטורית ומציינים שהחלפת מסד הייצור נותרה חסומה. בדיקת הזהות ב־Frankfurt מתארת בדיקת קריאה מוגבלת עם זהויות סינתטיות. פרסום הנהלים אינו מפעיל אותם, אינו מעביר את בסיס הנתונים ואינו אישור פרודקשן.