این یک متن ترجمه شده ماشینی است که ممکن است حاوی خطا باشد!
مستندسازی خوب، تفاوت بین به خاطر داشتن نحوه عملکرد چیزها و گیر کردن در ساعت 23 یکشنبه به دلیل از کار افتادن سرور و اینکه هیچکس نحوه راهاندازی آن را به خاطر نمیآورد، است. مستندسازی شاید هیجانانگیزترین بخش عملیات IT نباشد، اما یکی از مهمترین بخشهاست.
چرا مستندسازی کنیم؟
| دلیل | توضیح |
|---|---|
| حافظه | شما همه چیز را در شش ماه به خاطر نخواهید داشت، و نیازی هم به این کار ندارید |
| همکاری | دیگران باید بتوانند بدون پرسیدن از شما، بفهمند چه کاری انجام دادهاید |
| رفع اشکال | وقتی چیزی اشتباه است، دانستن اینکه چه چیزی طبیعی است بسیار ارزشمند است |
| بازسازی | اگر سروری از کار بیفتد، باید بدانید دقیقاً چگونه تنظیم شده بود |
| قابلیت ردیابی | چه چیزی تغییر کرد، چه زمانی و توسط چه کسی؟ |
Skriv dokumentasjonen for “fremtidig deg”
بهترین قاعده سرانگشتی: طوری بنویسید که انگار دارید آن را به خودتان بعد از شش ماه توضیح میدهید. با این کار مطمئن میشوید که جزئیات کافی را بدون پیچیده کردن بیش از حد، درج میکنید.
انواع مستندسازی در عملیات فناوری اطلاعات
نقشه شبکه
نقشه شبکه ساختار فیزیکی و/یا منطقی شبکه را نشان میدهد. این میتواند از یک طرح ساده تا یک نمودار دقیق با VLAN، آدرسهای IP و قوانین فایروال متغیر باشد.
یک نقشه شبکه خوب باید شامل موارد زیر باشد:
- تمام دستگاههای شبکه (سوئیچها، روترها، فایروال، نقاط دسترسی)
- ساختار VLAN با زیرشبکه
- آدرسهای IP برای دستگاههای مهم (سرورها، دروازه)
- اتصالات بین دستگاهها
طرح IP
یک طرح IP نمایشی از نحوه توزیع آدرسهای IP در شبکه است. این طرح به شما کمک میکند تا نظم را حفظ کرده و از تداخلها (دو دستگاه با یک آدرس) جلوگیری کنید.
مثال:
| VLAN | نام | زیرشبکه | دروازه | محدوده DHCP | یادداشت |
|---|---|---|---|---|---|
| 10 | مدیریت | 10.0.10.0/24 | 10.0.10.1 | .100 - .200 | دسترسی محدود |
| 20 | کارمندان | 10.0.20.0/24 | 10.0.20.1 | .100 - .250 | |
| 30 | دانشآموزان | 10.0.30.0/24 | 10.0.30.1 | .100 - .250 | فقط اینترنت |
| 50 | سرورها | 10.0.50.0/24 | 10.0.50.1 | ندارد (ایستا) | آدرسهای IP ثابت |
آدرسهای ایستا:
| آدرس IP | دستگاه | نقش |
|---|---|---|
10.0.50.10 | web-01 | Nginx |
10.0.50.11 | db-01 | PostgreSQL |
10.0.50.12 | monitoring-01 | Grafana + Loki |
10.0.50.20 | proxmox | Hypervisor |
چکلیستها
چکلیستها تضمین میکنند که هیچ چیزی فراموش نشود. آنها بهویژه برای وظایفی که کمتر انجام میدهید، مانند راهاندازی یک سرور جدید یا انجام یک بررسی امنیتی، مفید هستند.
مثال: چکلیست برای سرور جدید لینوکس:
- نصب سیستمعامل (Debian/Ubuntu)
- بهروزرسانی تمام بستهها (
sudo apt update && sudo apt upgrade) - ایجاد کاربر با دسترسی sudo
- غیرفعال کردن ورود root از طریق SSH
- پیکربندی فایروال (
ufw) - نصب نرمافزار ضروری
- تنظیم پشتیبانگیری
- مستندسازی سرور در طرح IP
- تست اینکه سرویس کار میکند
مستندسازی تغییرات
هر زمان که تغییری در محیط تولید (سرور، شبکه، سرویس) ایجاد میکنید، باید آن را مستند کنید. یک گزارش ساده میتواند کافی باشد:
## Endringslogg
### 2026-04-14 - Oppgradert Nginx
- **Hva:** Oppdatert Nginx fra 1.24 til 1.26
- **Hvorfor:** بهروزرسانی امنیتی (CVE-2025-XXXX)
- **Hvem:** Ola
- **Resultat:** OK, ingen nedetid
### 2026-04-10 - Nytt VLAN for IoT
- **Hva:** Opprettet VLAN 40 for IoT-enheter
- **Hvorfor:** جداسازی IoT از بقیه شبکه
- **Hvem:** Kari
- **Resultat:** OK, alle printere flyttet til VLAN 40
Bruk Git!
اگر مستندات را در فایلهای Markdown مینویسید (توصیه میشود)، میتوانید آنها را با Git کنترل نسخه کنید. به این ترتیب، به طور خودکار سابقه تمام تغییرات را خواهید داشت و میتوانید ببینید چه کسی چه چیزی را و چه زمانی تغییر داده است.
مستندات عملیاتی
مستندات عملیاتی نحوه عملکرد یک سیستم در وضعیت فعلی آن را شرح میدهد:
| چه چیزی | مثال |
|---|---|
| معماری سیستم | “ما Proxmox را با 3 ماشین مجازی: وب، پایگاه داده، نظارت اجرا میکنیم” |
| اطلاعات دسترسی | “SSH از طریق پورت 22، فقط از VPN” |
| روالهای پشتیبانگیری | “پشتیبانگیری روزانه در ساعت 02:00 به دیسک خارجی” |
| اطلاعات تماس | “در صورت بروز مشکل، با اولی (مدیر) تماس بگیرید” |
| مراحل بازیابی | “راهاندازی مجدد با: sudo systemctl restart nginx“ |
ابزارهای مستندسازی
| ابزار | برای چه استفاده میشود | مزایا |
|---|---|---|
| Markdown | متن با قالببندی ساده | سبک، قابل حمل، با Git کار میکند |
| draw.io | نمودارها و نقشههای شبکه | رایگان، بصری، خروجی به تصویر |
| Obsidian | برنامه یادداشتبرداری با Markdown و پیوند دادن | برای پایگاه دانش شخصی خوب است |
| MkDocs | انتشار Markdown به عنوان وبسایت | مستندسازی حرفهای |
| Git/GitHub | کنترل نسخه مستندسازی | تاریخچه، همکاری، پشتیبانگیری |
تکلیف 1 - ایجاد یک نقشه شبکه ساده
از draw.io (رایگان) برای ترسیم شبکه در خانه یا مدرسه استفاده کنید:
- با اتصال اینترنت و روتر شروع کنید
- سوئیچها و نقاط دسترسی را اضافه کنید
- سرورها، رایانههای شخصی و سایر دستگاهها را ترسیم کنید
- آدرسهای IP را در جایی که میدانید بنویسید
لازم نیست کامل باشد. نکته این است که شروع به فکر کردن بصری در مورد شبکه کنید.
وظیفه ۲ - لیست بررسی خود را ایجاد کنید
به کاری فکر کنید که به طور منظم با IT انجام میدهید (مثلاً راهاندازی یک VM جدید، نصب یک ماشین توسعه، یا پیکربندی VS Code). یک لیست بررسی برای این فرآیند بنویسید:
- چه مراحلی وجود دارد؟
- شما اغلب چه چیزی را فراموش میکنید؟
- آیا میتوانید برخی از مراحل را ساده کنید؟
آن را در یک سند Markdown ذخیره کنید تا بتوانید دفعه بعد از آن استفاده کنید.
تکلیف 3 - مستندسازی یکی از سرویسهای خود
یک سرویس که راهاندازی کردهاید (یک ماشین مجازی، یک کانتینر Docker، یک وبسرور) را انتخاب کنید و یک مستندات عملیاتی کوتاه بنویسید:
- این سرویس چه کاری انجام میدهد؟
- چگونه آن را شروع/متوقف میکنید؟
- آدرس IP و پورت آن چیست؟
- آیا پشتیبانگیری وجود دارد؟
آن را به صورت Markdown بنویسید و در یک مخزن Git قرار دهید.
خلاصه
- اسناد برای خود آیندهتان: طوری بنویسید که انگار دارید به کسی توضیح میدهید که هیچ چیز نمیداند
- نقشههای شبکه و طرحهای IP نمای کلی از زیرساخت را ارائه میدهند
- لیستهای بازرسی تضمین میکنند که هیچ چیز در وظایف تکراری فراموش نشود
- لاگهای تغییرات ردیابی میکنند که چه کاری انجام شده، چه زمانی و توسط چه کسی
- مستندات عملیاتی نحوه عملکرد سیستمها را در حال حاضر شرح میدهد
- از Markdown + Git برای مستندسازی آسان و با کنترل نسخه استفاده کنید