نظرة عامة على البرنامج
مقدمة:
يحدد التوثيق التقني لتقنية المعلومات سرعة معالجة الانقطاع ومدى أمان انتقال المنصة من فريق إلى آخر. فأدلة التشغيل تتقادم بعد أول ترقية، ومخططات الشبكة تخالف البيئة الفعلية، ومقالات قاعدة المعرفة تتكرر، والتسليم يعتمد على من بقي يتذكر الإعدادات. تأخذ هذه الدورة من كور كونسبت مديري الأنظمة والمهندسين وموظفي الدعم عبر كتابة التوثيق التشغيلي ورسم مخططاته وإدارة إصداراته وصيانته بأساليب أدلة التشغيل ونموذج C4 وإطار Diataxis والتوثيق كرمز برمجي ومنهجية KCS. ويبني المشاركون حزمة توثيق خدمة تقنية تضم دليل تشغيل ووثيقة معمارية ومقالات مترابطة في قاعدة المعرفة لخدمة تقنية في دراسة حالة.
أهداف الدورة:
- تدقيق الرصيد الحالي من وثائق فريق التقنية لكشف الفجوات والمحتوى المتقادم والمكرر والوثائق التي بلا مالك
- تصنيف المحتوى التشغيلي وفق إطار Diataxis لأنواع التوثيق وإسناد نموذج مناسب لكل عنصر
- كتابة أدلة التشغيل وإجراءات استكشاف الأعطال بخطوات قابلة للتحقق ونقاط قرار ومخرجات متوقعة وإجراءات تراجع
- إعداد توثيق المعمارية والإعدادات والشبكات بمخططات نموذج C4 وأدوات المخططات المكتوبة كرمز
- تمرير الوثائق عبر التحكم بالإصدارات في Git ومراجعة طلبات الدمج والاعتماد مع مالكين محددين ومواعيد مراجعة
- صيانة قاعدة معرفة الدعم بممارسات حلقتي الحل والتطوير في KCS وقياس إعادة استخدام المقالات وجودتها
الفئة المستهدفة:
- المهندسون الذين يديرون الخوادم والتخزين والمنصات السحابية وخدمات الدليل ويكتبون إجراءات تشغيلها
- مهندسو الشبكات والبنية التحتية الذين يسجلون المخططات الطوبولوجية والعناوين وإعدادات الأجهزة وسجل التغييرات
- العاملون في مكتب الخدمة والدعم الفني الذين يكتبون مقالات قاعدة المعرفة وأدلة الإصلاح ويعيدون استخدامها
- مهندسو العمليات والمناوبة الذين ينفذون أدلة التشغيل ويحدثونها أثناء الحوادث ونوافذ الصيانة
- ممارسو إدارة الخدمات الذين يحتفظون بسجلات الحوادث والمشكلات والتغييرات ويعدون حزم التسليم
- مهندسو دعم التطبيقات الذين يوثقون التكاملات والواجهات وخطوات النشر لأنظمة الإنتاج
محاور الدورة:
اليوم 1: أسباب إخفاق توثيق تقنية المعلومات وجرد رصيد الوثائق
- أعراض الدين التوثيقي: أدلة تشغيل متقادمة ومعرفة محصورة في الأفراد ونقاط إخفاق منفردة
- خريطة أنواع توثيق التقنية: المعمارية والإعدادات وأدلة التشغيل والسجلات ومقالات قاعدة المعرفة وأدلة المستخدم
- سيناريوهات القارئ: مهندس المناوبة ليلا والموظف الجديد والمدقق والمستخدم النهائي
- سجل جرد الوثائق بحقول المالك والموقع وتاريخ آخر مراجعة
- تقييم التقادم والفجوات مقابل قائمة فحص سلامة التوثيق
اليوم 2: نماذج التوثيق والقوالب وبنية المعلومات
- إطار Diataxis لأنواع التوثيق: الدروس التعليمية وأدلة المهام والمرجع والشرح
- مكونات قالب دليل التشغيل: المحفز والشروط المسبقة والخطوات والتحقق والتراجع
- قالب سجل قرارات المعمارية وأقسام وثيقة التصميم
- قالب مقالة قاعدة المعرفة: المشكلة والبيئة والسبب والحل
- هيكل مساحات الويكي وقواعد تسمية الصفحات ووسوم البيانات الوصفية
اليوم 3: كتابة أدلة التشغيل والإجراءات والمخططات التقنية
- صياغة الخطوات بصيغة الأمر مع كتل الأوامر والمخرجات المتوقعة ولقطات الشاشة
- أشجار قرار استكشاف الأعطال وجداول البحث عن رسائل الخطأ
- مخططات السياق والحاويات والمكونات في نموذج C4 لخدمة تقنية
- توثيق طوبولوجيا الشبكة ومخططات الخزائن وخطط عناوين IP
- المخططات المكتوبة كرمز باستخدام PlantUML ولغة Structurizr DSL
اليوم 4: التوثيق كرمز برمجي ومسارات المراجعة وإبقاء المحتوى محدثا
- مستودعات Markdown وAsciiDoc تحت التحكم بالإصدارات في Git
- مراجعة طلبات الدمج وبوابات الاعتماد وفحوص الدمج المشروطة بالتوثيق
- مصفوفة ملكية المحتوى ومواعيد المراجعة وقواعد الأرشفة
- حلقة الحل وحلقة التطوير في KCS لمعرفة مكتب الخدمة
- المرشحات لأتمتة أدلة التشغيل والتوثيق بوصفه دليلا للتدقيق وحزمة للتسليم
اليوم 5: بناء حزمة توثيق خدمة تقنية في دراسة حالة
- موجز الخدمة التقنية في دراسة الحالة: بوابة عملاء على استضافة سحابية مع قاعدة بيانات مشتركة
- صياغة أدلة تشغيل للتحويل الاحتياطي وتجديد الشهادات وإعادة تشغيل الخدمة
- بناء وثيقة المعمارية بمخططات C4 وسجلات القرارات
- إعداد مجموعة مقالات قاعدة المعرفة من تذاكر الحوادث المسجلة
- اختبار السير الميداني من الزملاء وبطاقة جودة التوثيق وعرض الحزمة
المهارات التي ستكتسبها:
- تأليف أدلة التشغيل
- تصميم إجراءات استكشاف الأعطال
- رسم المعمارية بنموذج C4
- توثيق الشبكات
- مسار التوثيق كرمز برمجي
- مراجعة الوثائق واعتمادها
- كتابة مقالات المعرفة
- قياس جودة التوثيق
لماذا تحضر هذه الدورة:
- العودة بحزمة توثيق خدمة تقنية تضم دليل تشغيل ووثيقة معمارية ومقالات قاعدة معرفة اختبرها الزملاء بالسير الفعلي عليها
- تقليص الوقت الضائع أثناء الحوادث في البحث عن خطوات لا توجد إلا في ذاكرة أحد الزملاء
- إدخال الوثائق في مسار المراجعة وسجل الإصدارات نفسه الذي تمر به الإعدادات والرموز البرمجية فتتوقف عن الانحراف
- مقارنة ممارسات التوثيق مع مهندسين وموظفي دعم من المصارف والاتصالات والرعاية الصحية والخدمات الحكومية والطاقة
الخاتمة:
يثبت التوثيق التشغيلي قيمته حين يستطيع مهندس المناوبة اتباعه دون الاتصال بكاتبه. تنتقل الدورة من أسباب إخفاق توثيق تقنية المعلومات وجرد الرصيد الحالي، إلى إطار Diataxis والقوالب المصممة لكل غرض، ثم إلى كتابة أدلة التشغيل وأشجار استكشاف الأعطال ومخططات C4 والشبكات، وصولا إلى التوثيق كرمز برمجي وبوابات المراجعة والملكية وممارسات KCS وأدلة التدقيق والتسليم. ويخرج المشاركون في اليوم الأخير بحزمة توثيق خدمة تقنية يمكن اعتمادها مرجعا لفريقهم.