"Checkout" hyzmatynyň kanar çykyşy

1) Amallaryň dokumentasiýasy näme üçin zerur?

• dilden bilimi gaýtalanýan amallara öwürýär;
• jogapkärçiligiň çäklerini we güýçleniş nokatlaryny kesgitleýär;
• gabat gelmek we howpsuzlyk üçin subutnamalar çeşmesi bolup hyzmat edýär;
• onbordingi çaltlaşdyrýar we "dar bokurdaklaryň" töwekgelçiligini azaldýar.

2) Resminamalaryň taksonomiýasy (näme üçin)

Policy (Syýasat): niýet we çarçuwalar ("näme we näme üçin"). Mysal: Waka-dolandyryş syýasaty.
Standard (Standart): hökmany iň pes talaplar ("näçe"). Mysal üçin: TLS şahadatnamalaryny täzelemegiň wagty.
SOP/Procedure (Standart amal prosedurasy): yzygiderli ädimler ("ýaly"). Mysal: Kanareýanyň ýaýrap çykmagy.
Runbook: adaty wakalar (alertler/amallar) üçin ädimme-ädim görkezmeler. Mysal: "API 5xx ulaldy - hereketleriň algoritmi".
Playbook: wariantlar we çatryklar bilen ssenariler boýunça çözgütler toplumy. Mysal: "Töleg üpjün edijisi bilen baglanyşykly meseleler".
KB (Bilim bazasy): jogaplar, SSS, gurallar boýunça salgylanmalar.
Checklist: hereketlerden öň hökmany maddalaryň gysgaça sanawy.
Record/Evidence: ýerine ýetirilen ädimler, ekran suratlary/ýazgylary/gollary.

3) Gowy dokumentirlemegiň ýörelgeleri

Ýeke-täk hakykat çeşmesi (SSOT). Resminamalar gaýtalanmaýar; püskürmek köne diýmekdir.
Docs-as-Code. Git-de saklaýarys, code-review geçýäris, wersiýalar we diffler görünýär.
Actionable-first. Başda - gysga kartoçka: haçan işe girizmeli, eýesi kim, näme etmeli, tamamlanmagyň ölçegleri.
Atomarlyk we salgylylyk. Bir resminama - bir wezipe/proses.
Täzelenmek ukyby. Aýdyň eýesi we SLA täzelenmeleri (mysal üçin, çärýekde).
Syn edilişi. Dashbordlara/alertlere/metriklere baglanyşyklar gurlan.
Howpsuzlyk-by-design. Duýgurlygyň klassifikasiýasy, syrlary gizlemek, elýeterlilige gözegçilik etmek.

4) Resminamanyň durmuş sikli (Governance)

1. Başlangyç: anketa/bilet → resminamanyň görnüşi → eýesi.
2. Taslama: şablon, iň az mysal, standartlara we SLO baglanyşyklary.
3. Review: tehniki (SRE/platforma/howpsuzlyk), prosedura (proses dolandyryjysy).
4. Çap etmek: ussat şahamçada, wersiýa/senä bellik etmek, status bermek (active/experimental/deprecated).
5. Okuw/Aragatnaşyk: üýtgeşmeleriň yglan edilmegi, gysga okuw/demo.
6. Retrospektiv: hadysalaryň/maşklaryň netijeleri boýunça düzedişler girizmek.
7. Audit we arhiw: üýtgemeýän yzlar (kim/haçan üýtgetdi), arhiwde köne wersiýalar.

5) SOP/Runbook gurluşy (iň az)

1. Kartoçka: Ady, Identifikator, Wersiýa/Senesi, Eýesi, Jogapkär rollar, Baglanyşykly syýasatlar/standartlar.
2. Haçan ulanmaly: başlamak şertleri (alert/waka/iş penjiresi).
3. Taýýarlyk: hukuklar/gurallar/maglumatlar, töwekgelçilik-baha bermek, aragatnaşyk.
4. Ädimler: belgili, buýruklar/skrinshotlar/garaşylýan netijeler bilen.
5. Üstünlik/yza gaýdyp geliş ölçegleri: anyk SLI/SLO-bosagaly gymmatlyklar.
6. Eskalasiýa: kim, haçan we nädip (kanal, telefon, üpjün ediji).
7. Howpsuzlyk/laýyklyk: duýgur maglumatlar, gadaganlyklar, hereketleriň ýazgylary.
8. Post-actions: biletleriň ýapylmagy, statusyň täzelenmegi, subutnamalary ýygnamak.
9. Üýtgeşmeleriň taryhy (changelog).

6) Resmileşdirmegiň stili we kadalary

Düşnükli we gysgaça: 1 ädim - 1 hereket - 1 netije.
Empress: "Ýerine ýetirmek"..., "Barlamak"..., "Yzyna gaýtarmak"....
Skrinshotlar/toparlar: ädimiň gapdalynda; buýruklar - göçürilýän bloklar; garaşylýan netijä üns beriň.
Üýtgeýşi: "Eger A → X ädim, eger B → Y ädim" şahalary.
Kogortnost: nirede degişli - sebitleri/üpjün edijileri/tenantlary görkeziň.
Lokalizasiýa: esasy resminamalar - azyndan 2 dilde; terjime ýagdaýyny görkeziň.
Bellikler we gözleg: hyzmat, komponent, üpjün ediji, hadysanyň görnüşi, SLO, wersiýa.

7) Docs-as-Code we gurallar

Ammar: Git (main/feat/bugfix), PR-review, required checks.
Format: Markdown/AsciiDoc; PlantUML/Mermaid diagrammalary; JSON/YAML shemalary.
Çap etmek: statiki sahypa (Docusaurus/MkDocs) + gözleg.
Barlamak: CI-lint, baglanyşyk synagy, orfografiýa, kod bloklarynyň tassyklaýjylary.
Integrations: ChatOps-command '/runbook open X ', iň soňky wersiýany alertlerde görkezmek.
Baglanyşyklar: CMDB/service-katalog dashbordlar.

8) Elýeterlilige gözegçilik etmek we klassifikasiýa

Классы: Public / Internal / Confidential / Restricted.
Bölmek: açyk görkezmeler (umumy statuslar) vs ýapyk (açarlar, buýruklar, tor diagrammalary).
Syrlar: tekstde gadagan; gizlin ammar we pleýsholderleri ulanmak.
Audit: duýgur SOP üçin okamak/üýtgetmek magazineurnaly.

9) Wakalar we goýberişler bilen baglanyşyk

Her alertde degişli runbook baglanyşygy bar.
Her hadysada - ulanylan SOP-e baglanyşyk we bellik çeki.
RCA-dan soň - CAPA-hereket hökmünde resminamalary täzelemek.
Goýberilmezden öň - checklist: yzyna gaýtarmaga taýynlyk, pese gaçmagyň baýdaklary, üpjün edijileriň aragatnaşyklary.

10) Iň az hökmany toplum (MVP-dok-paket)

Wakalar-dolandyryş we eskalasiýa syýasaty (SEV/P-derejeleri, wagtlar).
Gözegçilik we alert syýasaty (burn rate, kworum).
SOP: release/return (canary/blue-green), göçmek DB (expand/contract).
Runbook: "Ýokary error-rate", "Ösüş p99", "Tölegleriň üstünliginiň peselmegi", "TLS/DNS meselesi".
Daşarky üpjün edijileriň Playbook (tölegler/KYC/CDN): aragatnaşyklar, çäkler, folbekler.
Syrlary we elýeterliligi dolandyrmak syýasaty.
RCA we Post-mortem şablonlary.
Hyzmat eýeleriniň tablisasy (RACI) we daşbordlaryň kartasy.

11) Resminamalaryň hiliniň ölçegleri (resminamanyň SLO)

Coverage: SOP/Runbook bilen% kritik ýollar.
Freshness: resminamalaryň paýy täze N gün (mysal üçin 90).
Ulanyjylyk: runbook-a görä ýapylan hadysalaryň% -i.
Findability: islenýän resminamany gözlemek wagtynyň mediany (anketalar/bloglar boýunça).
Defect rate: rewyu synlarynyň sany/100 resminama.
Adoption: Dogry runbook baglanyşygy bolan alertleriň paýy.
Compliance evidence rate:% goşulan subutnamalar bilen meseleler.

12) Çek-listler

SOP dörediş barlagy

• Eýesi we maksatly diňleýjisi kesgitlenildi.
• Başlangyç şertleri we duralgalar bar.
• Ädimler gaýtalanyp bilner, başga bir inerener tarapyndan barlanýar.
• Dashbordlara/alertlere/gurallara baglanyşyklar ýerleşdirildi.
• Syr ýok; pleysholderler we vault baglanyşygy bar.
• Yza gaýdyp gelmek we güýçlenmek beýan edilýär.
• "Hereketlerden soň" çek sanawy goşuldy.
• Wersiýa, senesi, changelog.

Çek sanawy

• Resminama taksonomiýa laýyk gelýär (syýasaty we ädimleri garyşdyrmaýar).
• Dil ýönekeý, düşnüksiz, düşnüksiz.
• Buýruklar "gury geçişde "/duralgada barlandy.
• Töwekgelçilikler we gözegçilik nokatlary görkezilýär.
• Elýeterlilik (Internal/Restricted) dogry.
• CI-de linterler/tassyklaýjylar geçdi.

13) Lokalizasiýa, wersiýa we elýeterlilik

Wersiýasy: 'MAJOR. MINOR. PATCH ', bu ýerde MAJOR prosesleriň laýyklygyny bozýar.
Diller: "çeşme" dilini we terjimeleriň ýagdaýyny belläň (up-to-date/needs review).
Form-faktor: on-call üçin ykjam/gijeki ekran, IC çap kartoçkalary.

14) Dok-awtomatlaşdyryş (tejribeden)

CLI şablonlaryndan SOP çarçuwalaryny döretmek ('doc new sop --service = payments').
Hyzmat bellikleri boýunça soňky dashbordlara baglanyşyklary awto-goşmak.
Möhleti geçen resminamalar barada ýatlatma botlar (freshness SLA).
Audit üçin "Evidence" bukjasyny (PDF/ZIP) eksport etmek.
Hadysalaryň biletlerini çözgüt tapylanda ulanylan resminamalaryň wersiýasy bilen baglanyşdyrmak.

15) Howpsuzlyk we gabat gelmek

"Töwekgelçilikler" we "Gözegçilik çäreleri" hökmany bölümleri.
Gollar/heşler bilen üýtgewsiz arhiwde saklamak.
Standartlara baglanyşyk (mysal üçin, habarnamalaryň/retensiýanyň möhletleri), laýyklygyň aýdyň eýeleri.

16) Anti-patternler

Eýeleri we täzelenme senesi bolmadyk "Wiki-labirint".
Toparlar bilen garyşyk syýasatçylar - hiç kim näme etmelidigini tapmaz.
Kontekstsiz resminamalar (SLO, daşbordlar, eskalasiýa ýok).
Syrly ekran suratlary ýa-da CLI alternatiwasyz "şu ýere basyň" görkezmeleri.
"Bir guru nädip etmelidigini bilýär" - tribal knowledge.
Arhiw PDF-leri ýeke-täk wersiýa hökmünde redaktirlenmeýär, gözlenmeýär.

17) Şablonlar (bölekler)

SOP şlýapa (mysal)

SOP-ID: OPS-REL-001

18) Gündelik işe goşulmak

Hepdelik doc-tegelekler: 1-2 resminamany seljermek, täzelemek, tejribe alyşmak.
Game-days: Simulýasiýalarda SOP/Runbook hakykatyny barlamak.
Onbording: hökmany resminamalaryň toplumy arkaly täze gelenleriň ugry + gysga wizalar.
Dok-karz: ileri tutulýan gowulaşmalar beqlogy (impact × effort).

19) Jemleýji

Amallaryň dokumentasiýasy arhiw däl, iş guralydyr. Haçan-da bu kod hökmünde alnyp barylsa, onuň eýeleri bar, täzelik ölçegleri bar we hadysalara, neşirlere we okuwlara goşulýar, gurama öňünden aýdyp bolýar: az ýalňyşlyk, has çalt reaksiýa, düşnükli jogapkärçilik we audit taýýarlygy. Gysga ýazyň, yzygiderli täzeläň, rutini awtomatlaşdyryň - resminamalar wagt we pul tygşytlap başlar.