Checkout- ის კანარის გამოშვება

1) რატომ არის საჭირო ოპერაციების დოკუმენტაცია

• ზეპირი ცოდნა გადააქცევს განმეორებით პროცედურებს;
• განსაზღვრავს პასუხისმგებლობის საზღვრებს და ესკალაციის წერტილებს;
• ემსახურება შესაბამისობისა და უსაფრთხოების მტკიცებულებების წყაროს;
• აჩქარებს ონბორდინგს და ამცირებს „ვიწრო ყელის“ რისკებს.

2) დოკუმენტების ტაქსონომია (რა)

პოლიტიკა (პოლიტიკა): განზრახვები და ჩარჩოები („რა და რატომ“). მაგალითი: ინციდენტის მართვის პოლიტიკა.
სტანდარტი (სტანდარტი): სავალდებულო მინიმალური მოთხოვნები („რამდენი“). მაგალითი: TLS სერთიფიკატების განახლების დრო.
SOP/Procedure (სტანდარტული ოპერაციული პროცედურა): თანმიმდევრული ნაბიჯები („როგორც“). მაგალითი: გამოშვება კანარის განლაგებით.
Runbook: ეტაპობრივი ინსტრუქციები სტანდარტული მოვლენებისთვის (ალერტები/ოპერაციები). მაგალითი: „API 5xx გაიზარდა - მოქმედების ალგორითმი“.
Playbook: გადაწყვეტილებების ერთობლიობა სცენარების მიხედვით, ვარიანტებითა და ჩანგლებით. მაგალითი: „პრობლემები გადახდის პროვაიდერთან“.
KB (ცოდნის ბაზა): პასუხები, FAQ, ინსტრუმენტების სერთიფიკატები.
Checklist: მოქმედებების წინ სავალდებულო წერტილების მოკლე სია.
ჩანაწერები/საღამო: შესრულებული ნაბიჯების ჟურნალი, ეკრანული კადრები/ლოგოები/ხელმოწერები.

3) კარგი დოკუმენტაციის პრინციპები

ჭეშმარიტების ერთი წყარო (SSOT). დოკუმენტები არ არის დუბლირებული; სპრეი ნიშნავს მოძველებას.
Docs-as-Code. ჩვენ Git- ში შევინახავთ, ჩვენ ვივლით კოდირების მიმოხილვას, ვერსიებს და დიფებს - ჩანს.
Actionable-first. დასაწყისში - მოკლე ბარათი: როდის დაიწყეთ, ვინ არის მფლობელი, რა უნდა გააკეთოთ, დასრულების კრიტერიუმები.
ატომურობა და მიზნობრივი. ერთი დოკუმენტი არის ერთი ამოცანა/პროცესი.
განახლება. მკაფიო მფლობელი და SLA განახლებები (მაგალითად, კვარტალურად).
დაკვირვება. დაშბორდის/ალერტას/მეტრიკის ბმულები ინტეგრირებულია.
უსაფრთხოება. მგრძნობელობის კლასიფიკაცია, საიდუმლოების შენიღბვა, დაშვების კონტროლი.

4) დოკუმენტის სასიცოცხლო ციკლი

1. ინიციატივა: განაცხადი/თიკეტი - დოკუმენტის ტიპი - მფლობელი.
2. პროექტი: შაბლონი, მინიმალური მაგალითები, ბმულები სტანდარტებზე და SLO.
3. შურისძიება: ტექნიკური (SRE/პლატფორმა/უსაფრთხოება), პროცედურა (პროცესის მენეჯერი).
4. პუბლიკაცია: სამაგისტრო ფილიალში, ვერსიის/თარიღის აღნიშვნა, სტატუსის მინიჭება (აქტიური/ექსპერიმენტული/დეპრესიული).
5. ტრენინგი/კომუნიკაცია: ცვლილებების გამოცხადება, მოკლე ტრენინგი/დემო.
6. რეტროსპექტივა: ინციდენტების/სავარჯიშოების შედეგების მიხედვით, ცვლილებების შეტანა.
7. აუდიტი და არქივი: უცვლელი კვალი (ვინ/როდის შეიცვალა), არქივში მოძველებული ვერსიები.

5) სტრუქტურა SOP/Runbook (მინიმალური)

1. ბარათი: სახელი, იდენტიფიკატორი, ვერსია/თარიღი, მფლობელი, პასუხისმგებელი როლები, დაკავშირებული პოლიტიკა/სტანდარტები.
2. როდის უნდა გამოვიყენოთ: გაშვების პირობები (ალერტი/მოვლენა/სამუშაო ფანჯარა).
3. მომზადება: უფლებები/ინსტრუმენტები/მონაცემები, რისკის შეფასება, კომუნიკაცია.
4. ნაბიჯები: დანომრილი, გუნდებით/ეკრანებით/მოსალოდნელი შედეგებით.
5. წარმატების/გამოტოვების კრიტერიუმები: მკაფიო SLI/SLO ბარიერი მნიშვნელობები.
6. ესკალაცია: ვინ, როდის და როგორ (არხი, ტელეფონი, პროვაიდერი).
7. უსაფრთხოება/შესაბამისობა: მგრძნობიარე მონაცემები, აკრძალვები, მოქმედებების ჩანაწერები.
8. Post-actions: თიკეტების დახურვა, სტატუსის განახლება, მტკიცებულებების შეგროვება.
9. ცვლილებების ისტორია (changelog).

6) დიზაინის სტილი და წესები

ნათელია და მოკლედ: 1 ნაბიჯი - 1 მოქმედება - 1 შედეგი.
იმპერატივი: „შესრულება“..., „შემოწმება“..., „უკან დაბრუნება“....
ეკრანის კადრები/გუნდები: ნაბიჯის გასწვრივ; ბრძანებები - კოპირებული ბლოკები; გაითვალისწინეთ მოსალოდნელი დასკვნა.
ცვალებადობა: ფილიალები „თუ A არის ნაბიჯი X, თუ B არის ნაბიჯი Y“.
კოჰორტიზმი: სად არის შესაბამისი - მიუთითეთ რეგიონები/პროვაიდერები/ტენანტები.
ლოკალიზაცია: ძირითადი დოკუმენტები - მინიმუმ 2 ენაზე; მიუთითეთ თარგმანის სტატუსი.
ჭდეები და ძებნა: მომსახურება, კომპონენტი, პროვაიდერი, ინციდენტის ტიპი, SLO, ვერსია.

7) Docs-as-Code და ინსტრუმენტები

საცავი: Git (main/feat/bugfix), PR review, required checks.
ფორმატი: Markdown/AscíDoc; დიაგრამები PlantUML/Mermaid; JSON/YAML სქემები.
პუბლიკაცია: სტატიკური საიტი (Docusaurus/MkDocs) + ძებნა.
გადამოწმება: CI ლინტი, ბმულის ტესტი, მართლწერა, კოდის ბლოკის დამადასტურებლები.
ინტეგრაცია: ChatOps გუნდები '/runbook Open X ', ბოლო ვერსიის ჩვენება ალერტებში.
კომუნიკაციები: CMDB/სერვისის კატალოგი - დაშბორდის დოკუმენტაცია.

8) წვდომის კონტროლი და კლასიფიკაცია

Классы: Public / Internal / Confidential / Restricted.
განყოფილება: საზოგადოებრივი ინსტრუქციები (ზოგადი სტატუსები) დახურული (გასაღებები, ბრძანებები, ქსელის დიაგრამები).
საიდუმლოებები: ტექსტში აკრძალულია; გამოიყენეთ საიდუმლო საცავი და პლეისჰოლდერები.
აუდიტი: კითხვისა/ცვლილებების ჟურნალი მგრძნობიარე SOP- სთვის.

9) ინციდენტებთან და გამოშვებებთან კავშირი

თითოეულ ალერტაში არის ბმული შესაბამისი რუნბოკზე.
თითოეულ ინციდენტს აქვს ბმული გამოყენებული SOP და ნიშნის შემოწმებაზე.
RCA- ს შემდეგ - დოკუმენტების განახლება, როგორც CAPA მოქმედება.
გამოშვებამდე - checklist: დაბრუნების მზადყოფნა, დეგრადაციის დროშები, პროვაიდერების კონტაქტები.

10) მინიმალური სავალდებულო ნაკრები (MVP დოქის პაკეტი)

ინციდენტის მენეჯმენტისა და ესკალაციის პოლიტიკა (SEV/P დონე, ტაიმინგი).
მონიტორინგის სტანდარტი და ალერტის პოლიტიკოსი (ბურანი, კვორუმი).
SOP: გამოშვება/გამოტოვება (canary/blue-green), BD მიგრაცია (expand/contract).
Runbook: „მაღალი ერორი“, „ზრდა p99“, „გადახდის წარმატების ვარდნა“, „TLS/DNS პრობლემა“.
გარე პროვაიდერების Playbook (გადახდები/KYC/CDN): კონტაქტები, ლიმიტები, ხალხური.
საიდუმლოებებისა და წვდომის მართვის პოლიტიკა.
შაბლონები RCA და Post-mortem.
მომსახურების მფლობელთა ცხრილი (RACI) და დაშბორდის ბარათი.

11) დოკუმენტაციის ხარისხის მეტრიკა (დოკუმენტის SLO)

Coverage: კრიტიკული ბილიკების% SOP/Runbook- ით.
ფრეშნესი: დოკუმენტების წილი უფრო ახალია, ვიდრე N დღე (მაგალითად, 90).
Usability: ინციდენტების% დახურულია runbook- ის მიხედვით ესკალაციის გარეშე.
Findability: საშუალო დრო სასურველი დოკუმენტის მოსაძებნად (გამოკითხვების/ლოგოების მიხედვით).
გამოთვლითი: კომენტარის რაოდენობა რეპროდუქციაზე/100 დოკუმენტზე.
Adoption: ალერტების წილი runbook- ის სწორი მითითებით.
კომპლექსის ღონისძიება: დავალებების% თანდართული მტკიცებულებებით.

12) ჩეკის ფურცლები

SOP ჩეკის სია

• განსაზღვრულია მეპატრონე და სამიზნე აუდიტორია.
• არსებობს გაშვების პირობები და გაჩერების კრიტერიუმები.
• ნაბიჯები რეპროდუცირებულია, შემოწმებულია სხვა ინჟინრის მიერ.
• ჩამონტაჟებულია ბმულები დაშბორდები/ალერტები/ინსტრუმენტები.
• საიდუმლოების გარეშე; არის პლეი ჰოლდერები და ბმული vault- ზე.
• აღწერილია გამოტოვება და ესკალაცია.
• დაემატა ჩეკების სია „ქმედებების შემდეგ“.
• ვერსია, თარიღი, changelog.

ჩეკის სია

• დოკუმენტი შეესაბამება ტაქსონომიას (არ აირია პოლიტიკა და ნაბიჯები).
• ენა მარტივი, იმპერიული, ორაზროვნების გარეშე.
• გუნდები შემოწმებულია „მშრალ პერსპექტივაში „/სტეჯში.
• მითითებულია რისკები და საკონტროლო პუნქტები.
• წვდომა (Internal/Restricted) სწორია.
• გაიარა საბრძოლო ხომალდები/შემსრულებლები CI- ში.

13) ლოკალიზაცია, ვერსია და წვდომა

ვერსია: 'MAJOR. MINOR. PATCH ', სადაც MAJOR არღვევს პროცესების თავსებადობას.
ენები: აღნიშნეთ „წყარო“ ენა და თარგმანების სტატუსი (up-date/needs მიმოხილვა).
ფორმის ფაქტორი: მობილური/ღამის ჩვენება on-call- ისთვის, IC ბეჭდური ბარათები.

14) დოქის ავტომატიზაცია (პრაქტიკიდან)

SOP ჩარჩოების წარმოქმნა CLI შაბლონებიდან ('doc new sop -service = payments').
მანქანის ჩანართი ბოლო დაშბორდის ბმულები მომსახურების ნიმუშების მიხედვით.
ვადაგასული დოკუმენტების ბოტები (freshness SLA).
Evidence პაკეტის ექსპორტი აუდიტორისთვის პერიოდის განმავლობაში (PDF/ZIP).
ინციდენტების ტიკეტების დაკავშირება გადაწყვეტილების მისაღებად გამოყენებული დოკუმენტების ვერსიასთან.

15) უსაფრთხოება და შესაბამისობა

სავალდებულო სექციები „რისკები“ და „საკონტროლო ზომები“.
evidence შენახვა უცვლელი არქივში ხელმოწერებით/ჰეშებით.
სტანდარტებთან დაკავშირება (მაგალითად, შეტყობინებების/გადახედვის დრო), შესაბამისობის აშკარა მფლობელები.

16) ანტი შაბლონები

„ვიკი-ლაბირინთი“ მფლობელების გარეშე და განახლების თარიღები.
გუნდებთან შერეული პოლიტიკოსები ვერავინ იპოვის რა უნდა გააკეთოს.
დოკუმენტები კონტექსტის გარეშე (არ არსებობს SLO, დაშბორდები, ესკალაციები).
ეკრანის კადრები საიდუმლოებით ან ინსტრუქციებით „დაჭერით აქ“ CLI ალტერნატივის გარეშე.
„ერთმა გურუმ იცის როგორ“ - tribal knowledge ფიქსაციის გარეშე.
საარქივო PDF, როგორც ერთადერთი ვერსია - არ არის რედაქტირებული, არ ეძებს.

17) შაბლონები (ფრაგმენტები)

SOP ქუდი (მაგალითი)

SOP-ID: OPS-REL-001

18) ყოველდღიური მუშაობა

ყოველკვირეული doc წრეები: 1-2 დოკუმენტის ანალიზი, განახლება, გამოცდილების გაცვლა.
თამაშის დღეები: SOP/Runbook- ის რეალობის შემოწმება სიმულაციებში.
ონბორდი: ახალბედა მარშრუტი სავალდებულო დოკუმენტების სიმრავლით + მოკლე კვანძებით.
დოქის ვალი: პრიორიტეტული გაუმჯობესების ბაკალავრი (impact × effort).

19) შედეგი

ოპერაციების დოკუმენტაცია არ არის არქივი, არამედ სამუშაო ინსტრუმენტი. როდესაც ის ტარდება როგორც კოდი, მას ჰყავს მეპატრონეები, ახალი მეტრიკა და ინტეგრირებულია ინციდენტებში, გამოშვებებში და ტრენინგებში, ორგანიზაცია ხდება პროგნოზირებადი: ნაკლები შეცდომა, სწრაფი რეაქცია, გასაგები პასუხისმგებლობა და აუდიტის მზადყოფნა. დაწერეთ მოკლედ, განაახლეთ რეგულარულად, ავტომატიზირეთ რუტინა - და დოკუმენტაცია დაიწყებს დროისა და ფულის დაზოგვას.