کتابخانه ← فنی

فنی

راهنمای عملیات

Runbook

دستورالعمل مرحله‌ای برای عملیات تکرارشونده.

کاربرد

چه زمانی استفاده کنیم؟

✓ مناسب است

برای تصمیم، طراحی و مستندات فنی که باید مسیر روشن داشته باشند.

× مناسب نیست

وقتی هدف و مخاطب با سطح رسمیت و جزئیات این ساختار هماهنگ نیست.

روش اجرا

مراحل نوشتن

۱

زمینه فنی

این بخش را با یک گزاره روشن آغاز کنید و تنها شواهد مرتبط را ادامه دهید.

۲

مسئله یا تصمیم

این بخش را با یک گزاره روشن آغاز کنید و تنها شواهد مرتبط را ادامه دهید.

۳

ملاحظات

این بخش را با یک گزاره روشن آغاز کنید و تنها شواهد مرتبط را ادامه دهید.

۴

پیامد و پیگیری

این بخش را با یک گزاره روشن آغاز کنید و تنها شواهد مرتبط را ادامه دهید.

قالب آماده

اسکلت Markdown

# راهنمای عملیات## زمینه فنی- نکته اصلی - شاهد یا داده - پیامد## مسئله یا تصمیم- نکته اصلی - شاهد یا داده - پیامد## ملاحظات- نکته اصلی - شاهد یا داده - پیامد## پیامد و پیگیری- نکته اصلی - شاهد یا داده - پیامد

کنترل کیفیت

اشتباهات رایج

  • زمینه پیش از اصل مطلبخواننده را برای فهم موضوع منتظر نگذارید.
  • ادعای بدون شاهدهر نتیجه مهم باید داده یا استدلال قابل بررسی داشته باشد.
  • مخلوط کردن وظیفه بخش‌هاهر پاراگراف تنها یک نقش روشن داشته باشد.