שחרור הקנרית משירות הבקרה

1) מדוע אני זקוק לתיעוד העסקה?

• הופך ידע אוראלי להליכים ניתנים לחזרה;
• מגדיר גבולות אחריות ונקודות הסלמה
• משמש כמקור ראיות לציות וביטחון;
• מאיץ בעלייה למטוס ומפחית את הסיכונים של ”צוואר צר”.

2) טקסונומיה של מסמכים (מה זה מה)

מדיניות: כוונות ומסגרת (”מה ולמה”). דוגמה: מדיניות ניהול אירועים.
סטנדרטי: דרישות מינימום חובה (”כמה”). דוגמה: תאריכי חידוש תעודת TLS.
SOP/הליך: צעדים רציפים (”as”). דוגמה: שחרור עם גליל כנרי.
Runbook: הוראות צעד אחר צעד לאירועים טיפוסיים (התראות/פעולות). דוגמה: ”API 5xx גדל - אלגוריתם של פעולות”.
משחק: סט של פתרונות תרחיש עם אפשרויות ומזלגות. דוגמה: ”בעיות עם ספק תשלומים”.
KB (בסיס ידע): תשובות, FAQs, עזרת כלים.
רשימה - רשימה קצרה של פריטים דרושים לפני הפעולות.
תיעוד/ראיות: רישום של שלבים שלמים, צילומי מסך/רישומים/חתימות.

3) עקרונות של תיעוד טוב

מקור אמת יחיד (SSOT). מסמכים אינם משוכפלים; לרסס זה להפוך למיושן.
Docs-as-Code. אנחנו מאחסנים בגיט, מעבירים סקירת קוד, גרסאות ודיפוזיות גלויות.
ניתן לפעול-ראשון. בהתחלה - כרטיס קצר: מתי להתחיל, מי הבעלים, מה לעשות, קריטריונים להשלמה.
אטומיות וכתובת. מסמך אחד - משימה/תהליך אחד.
יכולת עדכון. בעלים נקיים ועדכוני SLA (למשל: רבעון).
יכולת תצפית. קישורים ללוחות מחוונים/התראות/מדדים מוטבעים.
אבטחה לפי עיצוב. סיווג רגישות, מיסוך סודי, בקרת גישה.

4) מחזור חיים של מסמך (ממשל)

1. חניכה: application/ticket # type product.
2. טיוטה: תבנית, דוגמאות מינימליות, התייחסות לסטנדרטים ו ־ SLO.
3. סקירה: טכנית (SRE/פלטפורמה/בטיחות), פרוצדורלית (מנהל תהליכים).
4. פרסום: בסניף הראשי, לציון הגרסה/תאריך, הקצאת המעמד (פעיל/ניסיוני/מנותק).
5. אימון/תקשורת: הודעה על שינויים, אימון/הדגמה קצרה.
6. רטרוספקטיבה: בהתבסס על התוצאות של אירועים/תרגילים, לבצע שינויים.
7. ביקורת וארכיון: עקבות בלתי ניתנות לשינוי (מי/מתי השתנה), גרסאות מיושנות בארכיון.

5) מבנה SOP/Runbook (מינימום)

1. כרטיס: שם, תעודת זהות, גרסה/תאריך, בעלים, תפקידים אחראיים, מדיניות/תקנים קשורים.
2. מתי ליישם: תנאי התחלה (חלון התראה/אירוע/עבודה).
3. הכנה: זכויות/כלים/נתונים, הערכת סיכונים, תקשורת.
4. צעדים: ממוספרים, עם פקודות/צילומי מסך/תוצאות צפויות.
5. קריטריונים מוצלחים: סף SLI/SLO נקי.
6. הסלמה: מי, מתי ואיך (ערוץ, טלפון, ספק).
7. נתונים רגישים, איסורים, רישומי פעולות.
8. פוסט-פעולות: סגירת כרטיסים, עדכון מצב, איסוף ראיות.
9. היסטוריה של שינויים (changelog).

6) כללי סגנון ועיצוב

ברור וקצר: צעד 1 1 פעולה - תוצאה 1.
הכרחי: ”בצע...”, ”בדוק...”, ”רול בחזרה”...
צילומי מסך/פקודות: ליד המדרגה; פקודות - בלוקים מועתקים; שימו לב לפלט הצפוי.
משתנה: ענפים ”אם A = שלב X, אם B = שלב Y”.
קוהורטה: היכן שמפורט אזורים/ספקים/דיירים רלוונטיים.
לוקליזציה: מסמכי מפתח - לפחות 2 שפות; ציין את מצב התרגומים.
תגיות וחיפוש: שירות, רכיב, ספק, סוג אירוע, SLO, גרסה.

7) Docs-as-קוד וכלים

אחסון: Git (ראשי/feat/bugfix), סקירת יחסי ציבור, בדיקות דרושות.
תבנית: Markdown/AscilDoc; תרשימים בתוכניות JSON/YAML/בתולת הים.
פרסום: אתר סטטי (Docusaurus/MkDocs) + חיפוש.
אימות: CI-מוך, מבחן קישור, איות, אימות בלוק קוד.
אינטגרציה: ChatOps פקודות '/runbook open X ', מציג את הגרסה האחרונה בהתראות.
קישורים: קטלוג CMDB/שירות ↔ תיעוד ↔ לוחות מחוונים.

8) בקרת גישה וסיווג

שירות ציבורי/פנימי/חסוי/מוגבל.
הפרדה: הוראות ציבוריות (סטטוסים כלליים) נגד פרטיות (מפתחות, פקודות, דיאגרמות רשת).
סודות: אסורים בטקסט; השתמש באחסון סודי ומומחי מיקום.
ביקורת - רישום קריאה/שינוי עבור SOPs רגישים.

9) תקשורת עם אירועים ומשחררים

בכל התראה - קישור לאלבום הרלוונטי.
בכל אירוע, התייחסות ל-SOP בשימוש ובדיקה של סימנים.
לאחר RCA - עדכון מסמכים כפעולת CAPA.
לפני השחרור - בדיקת רשימה: מוכנות גלגיליות, דגלי השפלה, אנשי קשר מספקים.

10) סט מינימלי נדרש (חבילת מזח MVP)

ניהול אירועים ומדיניות הסלמה (רמות SEV/P, Timings).
ניטור מדיניות סטנדרטית והתראה (קצב צריבה, מניין).
SOP: שחרור/rollback (קנרית/כחול-ירוק), נדידת מסד נתונים (להרחיב/חוזה).
Runbook: ”שגיאה בקצב גבוה”, ”גידול p99”, ”ירידה בהצלחה בתשלום”, ”בעיית TLS/DNS”.
ספר משחקים של ספקים חיצוניים (תשלומים/KYC/CDN): אנשי קשר, גבולות, פולבקים.
מדיניות ניהול סודית וגישה.
אר-סי-איי ותבניות שלאחר המוות.
שולחן בעלות על השירות (RACI) ומפת לוח המחוונים.

11) תיעוד איכות מטריצות (מסמך SLO)

כיסוי:% מהנתיבים הקריטיים עם SOP/Runbook.
רעננות: נתח המסמכים הוא עדכני יותר מ-N ימים (לדוגמה, 90).
שימושיות:% מהתקריות נסגרו על פי רישומים ללא הסלמה.
סבירות: זמן חיפוש חציוני עבור המסמך הרצוי (על ידי סקרים/יומנים).
שיעור הפגם: מספר הערות לפי סקירה/100 מסמכים.
אימוץ: אחוז התראות עם אזכור נכון.
שיעור ראיות ציות:% מהמשימות עם ראיות מצורפות.

12) רשימות בדיקה

רשימת בדיקות הבריאה של SOP

[ ] הבעלים וקהל היעד מוגדר.

[ ] יש תנאי התחלה ועצירת קריטריונים.

[ ] צעדים ניתנים לשחזור, נבדק על ידי מהנדס אחר.

[ ] קישורים מובנים ללוחות מחוונים/התראות/כלים.

[ ] אין סודות; יש בעלי מקומות וקישור לכספת.

[ ] מתאר את ההחזרה וההסלמה.

[ ] הוסף ”אחרי הפעולה” רשימה.

[ גרסה ], תאריך, צ 'אנג-לוג.

סקירה רשימה

[ מסמך ] מתאים לטקסונומיה (אינו מערבב מדיניות וצעדים).

[ ] השפה פשוטה, הכרחית, ללא עמימות.

[ צוותי ] נבחנו ב ”ריצה יבשה ”/שלב.

[ ] צוין סיכונים ונקודות שליטה.

[ ] פנימי/מוגבל נכון.

[ ] לינטרס/מאשרים עבר במודיע.

13) לוקליזציה, גירסה וזמינות

גרסה: "מייג 'ור. מינורי. פאץ ', היכן שתהליך גדול שובר תאימות.
שפות: Mark ”source” language and translation status (סקירה עדכנית/צריכה).
גורם צורה: תצוגה ניידת/לילה לכרטיסי IC מודפסים.

14) הרציף אוטומציה (מהתרגול)

יצירת מסגרות SOP מתבניות CLI (”doc new sop - service = תשלומים”).
הכנס קישורים אוטומטיים ללוחות המחוונים האחרונים על ידי תגי שירות.
מסמכי איחור תזכורת רובוטים (רעננות SLA).
ייצוא חבילת הראיות לתקופה (PDF/ZIP) לצורך ביקורת.
לשייך כרטיסי אירוע עם הגרסה של מסמכים בשימוש בפתרון.

15) בטיחות וציות

סעיפים מחייבים ”סיכונים” ו ”אמצעי בקרה”.
אחסון ראיות בארכיון לא משתנה עם חתימות/חשיש.
מחייב לתקנות (למשל: תקופות הודעה/שימור), בעלי ציות מפורש.

16) אנטי דפוסים

”מבוך וויקי” ללא בעלים ותאריכים עדכון.
פוליטיקאים מעורבים בצוותים, אף אחד לא ימצא מה לעשות.
מסמכים ללא הקשר (לא SLO, לוחות מחוונים, הסלמה).
צילומי מסך עם סודות או הוראות ”לחץ כאן” ללא חלופות CLI.
”גורו אחד יודע איך” - ידע שבטי ללא קיבעון.
PDFs ארכיון כגרסה היחידה לא ערוך, לא חיפוש.

17) תבניות (שברים)

SOP (דוגמה)

SOP-ID: OPS-REL-001

18) הטבעה בעבודה יומיומית

ניתוח של 1-2 מסמכים, עדכון, החלפת ניסיון.
ימי משחק: SOP/Runbook Reality לבדוק בסימולציות.
על העלייה למטוס: המסלול של מתחילים דרך קבוצה של מסמכים מחייבים + בחידות קצרות.
חוב עגינה: גיבוב של שיפורים עם עדיפות (impact xmex).

19) השורה התחתונה

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