Нашри Canary аз хидмати Checkout

1) Чаро ба ман ҳуҷҷатҳои транзаксия лозиманд?

• дониши шифоҳиро ба тартиби такрорӣ табдил медиҳад;
• Ҳудуди масъулият ва нуқтаҳои афзоишро муайян мекунад
• ҳамчун манбаи далелҳо барои мувофиқат ва бехатарӣ хизмат мекунад;
• дар киштӣ суръат мебахшад ва хатари "гарданҳои танг" -ро коҳиш медиҳад.

2) Ҳуҷҷати таксономия (чӣ аст)

Сиёсат: ниятҳо ва чаҳорчӯба ("чӣ ва чаро"). Мисол: Сиёсати идоракунии ҳодисаҳо.
Стандарт: талаботи ҳадди аққали ҳатмӣ ("чӣ қадар"). Мисол: Санаи таҷдиди шаҳодатномаи TLS.
SOP/Тартиби: қадамҳои пайдарпай ("ҳамчун"). Мисол: Озод бо рол канарӣ.
Китоби корӣ: дастурҳои зина ба зина барои рӯйдодҳои маъмулӣ (огоҳиҳо/амалиётҳо). Мисол: "API 5xx афзоиш ёфтааст - алгоритми амалҳо".
Китоби бозӣ: маҷмӯи қарорҳои сенария бо имконот ва ғилдиракҳо. Мисол: "Мушкилот бо провайдери пардохт".
KB (Пойгоҳи дониш): ҷавобҳо, FAQ, кӯмаки асбобҳо.
Рӯйхати назоратӣ - рӯйхати мухтасари ашёҳои зарурӣ пеш аз амал.
Сабт/Далелҳо: сабти қадамҳои анҷомшуда, скриншотҳо/гузоришҳо/имзоҳо.

3) Принсипҳои ҳуҷҷатҳои хуб

Манбаи ягонаи ҳақиқат (SSOT). Ҳуҷҷатҳо такрор карда намешаванд; пошидан кӯҳна шудан аст.
Ҳуҷҷатҳо-ас-Кодекс. Мо дар Git нигоҳ медорем, баррасии рамзҳо, версияҳо ва диффузҳо намоёнанд.
Амал-аввал. Дар оғоз - корти кӯтоҳ: кай бояд оғоз кард, соҳиби кист, чӣ бояд кард, меъёрҳои анҷомёбӣ.
Атом ва адресатсия. Як ҳуҷҷат - як вазифа/раванд.
Навсозӣ. Навсозиҳои соҳиби ва SLA (масалан, семоҳа).
Мушоҳида. Истинодҳо ба панели панелҳо/огоҳиҳо/ченакҳо ҷойгир карда шудаанд.
Тарроҳии амният. Таснифи ҳассосият, ниқоби махфӣ, назорати дастрасӣ.

4) Давраи ҳаёти ҳуҷҷатҳо (Идоракунӣ)

1. Ташаббус: ариза/чипта → намуди ҳуҷҷат → соҳиби.
2. Лоиҳа: қолаб, намунаҳои ҳадди аққал, истинод ба стандартҳо ва SLO.
3. Шарҳ: техникӣ (SRE/платформа/бехатарӣ), мурофиавӣ (менеҷери раванд).
4. Нашр: дар шохаи усто, бо нишон додани версия/сана, таъини мақом (фаъол/таҷрибавӣ/фарсуда).
5. Омӯзиш/Иртибот: эълони тағирот, омӯзиши кӯтоҳ/намоишӣ.
6. Ретроспектива: дар асоси натиҷаҳои ҳодисаҳо/машқҳо, тағирот ворид кунед.
7. Аудит ва бойгонӣ: пайгирии тағйирнопазир (кӣ/ҳангоми тағир додан), нусхаҳои кӯҳна дар бойгонӣ.

5) Сохтори SOP/Runbook (ҳадди аққал)

1. Корт: Ном, ID, версия/сана, соҳиб, нақшҳои масъул, сиёсатҳо/стандартҳои марбута.
2. Кай бояд татбиқ шавад: шартҳои оғоз (ҳушдор/ҳодиса/равзанаи корӣ).
3. Омодагӣ: ҳуқуқ/воситаҳо/маълумот, арзёбии хатар, иртибот.
4. Қадамҳо: рақамгузорӣ карда шуда, бо фармонҳо/скриншотҳо/натиҷаҳои интизоршаванда.
5. Меъёрҳои муваффақият/бозгашт: ҳадди ниҳоии SLI/SLO.
6. Афзоиш: кӣ, кай ва чӣ тавр (канал, телефон, провайдер).
7. Амният/мувофиқат: маълумоти ҳассос, манъкунӣ, сабти амалҳо.
8. Амалҳои баъдӣ: пӯшидани чиптаҳо, таҷдиди вазъ, ҷамъоварии далелҳо.
9. Таърихи тағирот (changelog).

6) Қоидаҳои услуб ва тарроҳӣ

Равшан ва кӯтоҳ: 1 қадам - 1 амал - 1 натиҷа.
Ҳатмӣ: "Иҷро кунед"..., "Санҷед"..., "Бозгардонед"....
Скриншотҳо/фармонҳо: дар паҳлӯи қадам; фармонҳо - блокҳои нусхабардорӣ; натиҷаи интизорравандаро қайд кунед.

Тағйирпазирӣ: шохаҳои "Агар А → қадами X, агар B → қадами Y."

Cohort: дар ҷойҳои мувофиқ - минтақаҳо/провайдерҳо/иҷорагиронро муайян кунед.
Маҳаллисозӣ: ҳуҷҷатҳои асосӣ - ҳадди аққал 2 забон; Ҳолати тарҷумаҳоро муайян кунед.
Барчаспҳо ва ҷустуҷӯ: хидмат, ҷузъ, провайдер, навъи ҳодиса, SLO, версия.

7) Ҳуҷҷатҳо ва асбобҳо

Нигоҳдорӣ: Git (main/feat/bugfix), баррасии PR, чекҳои зарурӣ.
Формат: Маркдаун/Аскии Док; Диаграммаҳо дар нақшаҳои Plant/UML/Mermaid JSON/YAML.
Нашр: сайти статикӣ (Docusaurus/MKdocs) + ҷустуҷӯ.
Санҷиш: CI-линт, санҷиши пайванд, имло, тасдиқи блокҳои рамзӣ.
Интегратсияҳо: Chat 'Ops фармон медиҳад '/runbook open X', ки версияи охиринро дар огоҳиҳо нишон медиҳад.
Истинодҳо: Каталоги CMDB/хидмат ↔ ҳуҷҷатгузорӣ ↔ панели панелҳо.

8) Назорат ва таснифи дастрасӣ

Классы: Ҷамъиятӣ/Дохилӣ/Махфӣ/Маҳдуд.
Ҷудосозӣ: дастурҳои давлатӣ (ҳолати умумӣ) против хусусӣ (калидҳо, фармонҳо, диаграммаҳои шабакавӣ).
Асрҳо: дар матн манъ карда шудааст; нигаҳдории махфӣ ва ҷойгузинҳоро истифода баред.
Аудит - Сабти хондан/тағир додан барои SOP-ҳои ҳассос.

9) Иртибот бо ҳодисаҳо ва релизҳо

Дар ҳар як ҳушдор - пайванд ба дафтарчаи дахлдор.
Дар ҳар як ҳодиса, истинод ба SOP ва санҷиши аломатҳо истифода мешавад.
Пас аз RCA - таҷдиди ҳуҷҷатҳо ҳамчун амали CAPA.
Пеш аз озод шудан - рӯйхати назоратӣ: омодагии бозгашт, парчамҳои таназзул, тамосҳои провайдер.

10) Маҷмӯи ҳадди ақали зарурӣ (бастаи MVP Dock)

Идоракунии ҳодисаҳо ва сиёсати афзоиш (сатҳи SEV/P, мӯҳлатҳо).
Мониторинги стандарт ва сиёсати ҳушдор (сатҳи сӯхтан, кворум).
SOP: озодкунӣ/бозгашт (канарӣ/кабуд-сабз), муҳоҷирати пойгоҳи додаҳо (васеъ/шартнома).
Китоби корӣ: "Сатҳи баланди хатогӣ", "афзоиши p99", "Паст шудани муваффақияти пардохт", "Мушкилоти TLS/DNS".
Китоби бозикунии провайдерҳои беруна (пардохтҳо/KYC/CDN): алоқаҳо, маҳдудиятҳо, пӯшишҳо.
Сиёсати идоракунии махфӣ ва дастрасӣ.
Қолабҳои RCA ва пас аз марг.
Ҷадвали моликияти хидматрасонӣ (RACI) ва харитаи панел.

11) Нишондиҳандаҳои сифати ҳуҷҷатгузорӣ (Ҳуҷҷати SLO)

Фарогирӣ:% роҳҳои муҳим бо SOP/Runbook.
Тару тоза: ҳиссаи ҳуҷҷатҳо нисбат ба N рӯз наздиктар аст (масалан, 90).
Истифодабарӣ:% ҳодисаҳо мувофиқи дафтарчаи корӣ бидуни шиддат баста шудаанд.
Имконпазирӣ: вақти ҷустуҷӯи медианӣ барои ҳуҷҷати дилхоҳ (аз рӯи пурсишҳо/гузоришҳо).
Меъёри норасоӣ: шумораи шарҳҳо барои барраси/100 ҳуҷҷат.
Қабул: фоизи огоҳиҳо бо истинодҳои дурусти дафтар.
Меъёри далелҳои мутобиқат:% вазифаҳо бо далелҳои замимашуда.

12) Рӯйхати санҷишҳо

Рӯйхати санҷиши эҷоди SOP

• Соҳиб ва шунавандагони мақсаднок муайян карда шуданд.
• Шартҳои оғоз ва меъёрҳо вуҷуд доранд.
• Қадамҳо такроршаванда мебошанд, аз ҷониби муҳандиси дигар тафтиш карда мешаванд.
• Пайвандҳои дарунсохт ба панели панелҳо/огоҳиҳо/асбобҳо.
• Асрҳо нестанд; ҷойгузинҳо ва пайванди амудӣ мавҷуданд.
• Бозгашт ва авҷгириро тавсиф мекунад.
• Рӯйхати назоратии "пас аз амал" илова карда шуд.
• Версия, сана, changelog.

Рӯйхати назоратӣ

• Ҳуҷҷат ба таксономия мувофиқат мекунад (сиёсатҳо ва қадамҳоро омехта намекунад).
• Забон содда, ҳатмист, бидуни номуайянӣ.
• Дастаҳо дар "давиши хушк "/марҳила озмоиш карданд.
• Хатарҳо ва нуқтаҳои назоратӣ нишон дода шудаанд.
• Дохилӣ/Маҳдудият дуруст аст.
• Линтерҳо/валидаторҳо дар CI гузаштанд.

13) Маҳаллисозӣ, версия ва мавҷудият

Версия: 'MAJOR. МИНОР. PATCH ', ки дар он MAJOR мутобиқати равандро мешиканад.
Забонҳо: Марқӯс "манбаъ" забон ва тарҷума (баррасии муосир/эҳтиёҷот).
Омили шакл: намоиши мобилӣ/шабона барои занг, кортҳои чопшудаи IC.

14) Автоматикунонии док (аз амалия)

Тавлиди чаҳорчӯбаи SOP аз қолабҳои CLI ('doc new sop --service = пардохт').
Худкорона гузоштани пайвандҳо ба панелҳои навтарин аз рӯи барчаспҳои хидматӣ.
Ҳуҷҷатҳои кӯҳна ба ботҳо хотиррасон мекунанд (SLA тару тоза).
Бастаи далелҳоро барои давра (PDF/ZIP) барои аудит содир кунед.
Шиносоии чиптаҳои ҳодиса бо нусхаи ҳуҷҷатҳои дар ҳалли истифодашуда.

15) Бехатарӣ ва риояи

Бахшҳои ҳатмии "Хатарҳо" ва "Чораҳои назоратӣ".
Нигоҳ доштани далелҳо дар бойгонии бетағйир бо имзоҳо/хэшҳо.
Ҳатмӣ ба қоидаҳо (масалан, давраҳои огоҳӣ/нигоҳдорӣ), соҳибони возеҳи мувофиқат.

16) Анти-намунаҳо

"Wiki Maze" бидуни соҳибон ва санаҳои навсозӣ.
Сиёсатмадорон бо гурӯҳҳо омехта мешаванд - касе намеёбад, ки чӣ кор кунад.
Ҳуҷҷатҳои бидуни контекст (не SLO, панели панел, шиддат).
Скриншотҳо бо асрори ё дастурҳои "инҷоро клик кунед" бидуни алтернативаҳои CLI.
"Як гуру медонад, ки чӣ тавр" - дониши қабилавӣ бидуни ислоҳ.
PDF-ҳои бойгонишуда ҳамчун нусхаи ягона таҳрир карда намешаванд, ҷустуҷӯ карда намешаванд.

17) Қолибҳо (пораҳо)

Сарпӯши SOP (мисол)

SOP-ID: OPS-REL-001

18) Ҷобаҷогузорӣ ба кори ҳаррӯза

Доираҳои ҳафтаина: таҳлили 1-2 ҳуҷҷат, навсозӣ, мубодилаи таҷриба.
Рӯзҳои бозӣ: Санҷиши воқеияти SOP/Runbook дар моделсозӣ.
Ҳавопаймо: масири шурӯъкунандагон тавассути маҷмӯи ҳуҷҷатҳои ҳатмӣ + викторинаҳои кӯтоҳ.
Қарзи банд: ақибмонии беҳбудӣ бо афзалият (таъсир × саъй).

19) Сатри поён

Ҳуҷҷатҳои муомилот бойгонӣ не, балки воситаи корӣ мебошанд. Вақте ки он ҳамчун рамз идора карда мешавад, соҳибон, ченакҳои тару тоза дорад ва ба ҳодисаҳо, релизҳо ва омӯзиш дохил карда мешавад, ташкилот пешгӯишаванда мегардад: хатогиҳои камтар, аксуламалҳои тезтар, масъулияти фаҳмо ва омодагӣ ба аудит. Мухтасар нависед, мунтазам навсозӣ кунед, реҷаро автоматӣ кунед - ва ҳуҷҷатҳо сарфаи вақт ва пулро оғоз мекунанд.