قالب الـ Runbook

الـ runbooks تعيش في repo كل مشروع (بجانب الكود، ومُدارة بنُسخه)، لا في هذا الـ wiki. هذه الصفحة هي القالب فقط — لا يوجد فهرس للـ runbooks في الـ wiki، لأن الفهرس حالةٌ خاصة بكل عميل وهذا الـ wiki لا يحمل ذلك أبدًا. بدلًا من ذلك، docs/runbook.md هو ملف من ملفات اليوم الأول عند التوفير، فيُجاب سؤال «هل لهذا النظام runbook؟» بالنظر في الـ repo لا بالوثوق بجدول. وحين يتعارض runbook مع الـ wiki، فالغلبة لـ runbook الموجود في الـ repo.

شكل الـ deploy / rollback

sequenceDiagram
  participant Dev as Engineer
  participant CI as Pipeline
  participant Env as Environment
  Dev->>CI: Merge to main
  CI->>Env: Deploy build
  Env-->>Dev: Health check
  Note over Dev,Env: On failure
  Dev->>CI: Re-run last-good build
  CI->>Env: Rollback deploy

القالب

انسخه إلى /docs/runbook.md في repo المشروع واملأ كل <placeholder>.

# <System name> — Runbook

## Overview
- Purpose: <what this system does>
- Owner / team lead: <name>
- Repo: <repo url>  |  Environments: <qa / uat / prod urls>

## Deploy
1. <trigger — e.g. squash-merge PR to main>
2. <pipeline name in Azure DevOps>
3. <post-deploy health check + expected result>

## Rollback
1. <how to identify last-good build>
2. <re-deploy / swap-slot steps>
3. <verify rollback succeeded>

## Logs & monitoring
- Logs: <where — e.g. App Insights / log stream>
- Dashboards / alerts: <links>

## Restart
- <how to safely restart the service / app>

## Backup & restore
- Backup: <what, schedule, where stored>
- Restore: <step-by-step, and how to verify>

## Dependencies
- <DBs, queues, third-party APIs, Key Vault secrets>

## Contacts
- L2 team lead: <name>  |  Original dev: <name>

## Gotchas
- <known traps, manual steps, ordering constraints>

نصيحة

اجعله تشغيليًا — الخطوات التي ينفّذها مهندس الوردية المُتعَب بسرعة. أمّا المعمارية فمكانها ADR لا هنا.

انظر أيضًا نموذج الدعم والاستجابة للحوادث.