هذا نص مترجم آليًا وقد يحتوي على أخطاء!
التوثيق الجيد هو الفرق بين تذكر كيفية عمل الأشياء والوقوف في الساعة 23 يوم الأحد لأن الخادم معطل ولا يتذكر أحد كيفية إعداده. قد لا يكون التوثيق الجزء الأكثر إثارة في عمليات تكنولوجيا المعلومات، ولكنه أحد أهمها.
لماذا التوثيق؟
| السبب | التفسير |
|---|---|
| الذاكرة | لن تتذكر كل شيء بعد ستة أشهر، ولا تحتاج إلى ذلك أيضًا |
| التعاون | يجب أن يكون الآخرون قادرين على فهم ما فعلته دون أن يسألوك |
| استكشاف الأخطاء وإصلاحها | عندما يكون هناك خطأ ما، من لا يقدر بثمن معرفة ما هو طبيعي |
| إعادة البناء | إذا تعطل الخادم، فأنت بحاجة إلى معرفة بالضبط كيف تم إعداده |
| إمكانية التحقق | ما الذي تم تغييره ومتى ومن قبل من؟ |
Skriv dokumentasjonen for “fremtidig deg”
القاعدة الأساسية الأفضل: اكتب كما لو كنت تشرح لنفسك بعد ستة أشهر. سيضمن لك ذلك تضمين تفاصيل كافية دون تعقيد الأمور.
أنواع التوثيق في تشغيل تكنولوجيا المعلومات
Det finnes mange typer dokumentasjon som brukes i IT-drift. Noen av de vanligste er:
- Brukerdokumentasjon: Beskriver hvordan sluttbrukere skal bruke systemet.
- Systemdokumentasjon: Beskriver hvordan systemet er bygget opp og fungerer.
- Driftsdokumentasjon: Beskriver hvordan systemet skal driftes og vedlikeholdes.
- Feilhåndteringsdokumentasjon: Beskriver hvordan feil skal håndteres og løses.
- Sikkerhetsdokumentasjon: Beskriver sikkerhetsaspekter ved systemet.
God dokumentasjon er viktig for å sikre stabil og effektiv IT-drift. Den gjør det enklere å forstå systemet, feilsøke problemer og utføre vedlikehold.
يوجد العديد من أنواع الوثائق المستخدمة في تشغيل تكنولوجيا المعلومات. بعض الأنواع الأكثر شيوعًا هي:
- وثائق المستخدم: تصف كيفية استخدام المستخدمين النهائيين للنظام.
- وثائق النظام: تصف كيفية بناء النظام وعمله.
- وثائق التشغيل: تصف كيفية تشغيل النظام وصيانته.
- وثائق معالجة الأخطاء: تصف كيفية التعامل مع الأخطاء وحلها.
- وثائق الأمان: تصف جوانب الأمان الخاصة بالنظام.
الوثائق الجيدة مهمة لضمان تشغيل تكنولوجيا المعلومات المستقر والفعال. إنها تجعل من السهل فهم النظام واستكشاف الأخطاء وإجراء الصيانة.
خريطة الشبكة
تُظهر خريطة الشبكة الهيكل المادي و/أو المنطقي للشبكة. يمكن أن تكون أي شيء من رسم تخطيطي بسيط إلى رسم بياني مفصل مع شبكات 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 |
قوائم التحقق
تضمن قوائم التحقق عدم نسيان أي شيء. وهي مفيدة بشكل خاص للمهام التي تقوم بها بشكل أقل تكرارًا، مثل إعداد خادم جديد أو إجراء مراجعة أمنية.
مثال: قائمة تحقق لخادم Linux جديد:
- تثبيت نظام التشغيل (Debian/Ubuntu)
- تحديث جميع الحزم (
sudo apt update && sudo apt upgrade) - إنشاء مستخدم مع حق الوصول إلى sudo
- تعطيل تسجيل الدخول إلى الجذر عبر 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:** عزل إنترنت الأشياء عن بقية الشبكة
- **Hvem:** Kari
- **Resultat:** OK, alle printere flyttet til VLAN 40
Bruk Git!
إذا كنت تكتب الوثائق في ملفات Markdown (مستحسن)، يمكنك التحكم في الإصدارات باستخدام Git. وبهذه الطريقة، سيكون لديك سجل تلقائي لجميع التغييرات، ويمكنك معرفة من قام بتغيير ماذا ومتى.
توثيق التشغيل
توثيق التشغيل يصف كيفية عمل النظام في حالته الحالية:
| ماذا | مثال |
|---|---|
| بنية النظام | “نقوم بتشغيل Proxmox مع 3 أجهزة افتراضية: الويب، وقاعدة البيانات، والمراقبة” |
| معلومات الوصول | “SSH عبر المنفذ 22، فقط من VPN” |
| إجراءات النسخ الاحتياطي | “النسخ الاحتياطي اليومي في الساعة 02:00 إلى قرص خارجي” |
| معلومات الاتصال | “في حالة وجود مشاكل، اتصل بـ Ola (المسؤول)” |
| خطوات الاستعادة | “إعادة التشغيل باستخدام: sudo systemctl restart nginx“ |
أدوات التوثيق
| الأداة | ما الذي تُستخدم له | المزايا |
|---|---|---|
| Markdown | نص بتنسيق بسيط | خفيف الوزن، محمول، يعمل مع Git |
| draw.io | الرسوم البيانية والخرائط الشبكية | مجاني، مرئي، تصدير إلى صورة |
| Obsidian | تطبيق تدوين الملاحظات باستخدام Markdown والربط | جيد لقاعدة المعرفة الشخصية |
| MkDocs | نشر Markdown كموقع ويب | توثيق احترافي |
| Git/GitHub | التحكم في إصدار التوثيق | سجل، تعاون، نسخة احتياطية |
المهمة 1 - إنشاء خريطة شبكة بسيطة
استخدم draw.io (مجاني) لرسم الشبكة في المنزل أو في المدرسة:
- ابدأ باتصال الإنترنت وجهاز التوجيه
- أضف المحولات ونقاط الوصول
- ارسم الخوادم وأجهزة الكمبيوتر والأجهزة الأخرى
- اكتب عناوين IP حيث تعرفها
لا يجب أن يكون مثاليًا. الفكرة هي البدء في التفكير بصريًا حول الشبكة.
المهمة 2 - أنشئ قائمة تحقق خاصة بك
فكر في شيء تفعله بانتظام باستخدام تكنولوجيا المعلومات (مثل إعداد جهاز افتراضي جديد، أو تثبيت جهاز تطوير، أو تكوين VS Code). اكتب قائمة تحقق للعملية:
- ما هي جميع الخطوات؟
- ما الذي تنساه في أغلب الأحيان؟
- هل يمكنك تبسيط بعض الخطوات؟
احفظها في مستند Markdown حتى تتمكن من استخدامها في المرة القادمة.
المهمة 3 - وثّق إحدى خدماتك
اختر خدمة قمت بإعدادها (جهاز افتراضي، حاوية Docker، خادم ويب) واكتب وثائق تشغيل موجزة:
- ما الذي تفعله الخدمة؟
- كيف تبدأ/توقف الخدمة؟
- ما هو عنوان IP والمنفذ؟
- هل توجد نسخة احتياطية؟
اكتب ذلك باستخدام Markdown وضعه في مستودع Git.
ملخص
- وثائق للذات المستقبلية: اكتب كما لو كنت تشرح لشخص لا يعرف شيئًا
- خرائط الشبكة و خطط عناوين IP توفر نظرة عامة على البنية التحتية
- قوائم التحقق تضمن عدم نسيان أي شيء في المهام المتكررة
- سجلات التغيير تتبع ما تم إجراؤه ومتى ومن قبل من
- وثائق التشغيل تصف كيف تعمل الأنظمة اليوم
- استخدم Markdown + Git لتوثيق سهل مع التحكم في الإصدارات