دورة تدريبية في التوثيق التقني وأدلة استخدام البرمجيات
1نظرة عامة
كل تذكرة دعم بيحلّها الفريق بشرح حاجة كان المفروض تكون متوثقة من الأساس، هي ضريبة صغيرة ومتكررة على الأعمال - وبتتراكم أسرع مما تتخيل كتير من المؤسسات. أدلة المستخدم القديمة، ومراجع واجهات البرمجة اللي بقت مش مطابقة للمنتج، ومقالات قاعدة المعرفة اللي محدش لاقيها، كل ده بيرجّع الأسئلة الروتينية للناس بدل ما التوثيق يجاوب عليها. دورة التوثيق التقني وأدلة استخدام البرمجيات من أكاديمية الزمالة العربية البريطانية موجودة عشان تسد الفجوة دي.
تغطي الدورة كل أنواع المحتوى التقني اللي بتعتمد عليه مؤسسة تقنية حديثة - أدلة المستخدم، ووثائق واجهات البرمجة، وملاحظات الإصدار، ومقالات قاعدة المعرفة، وأدلة الأسلوب - وتربطهم بهندسة المعلومات وانضباط إدارة الإصدارات اللي بيخلّي مجموعات التوثيق الكبيرة قابلة للاستخدام مع تطور المنتج. كما تتناول الجانب الخاص بالحوكمة: الملكية وعمليات المراجعة، وإزاي التوثيق بيندمج في عمليات التطوير والمنتج والدعم اليومية بدل ما يكون مجرد فكرة لاحقة.
2الأهداف والفئة المستهدفة
في نهاية الدورة، هيقدر المشاركون على:
- تحديد أهداف التوثيق وملكيته ومعايير جودته عبر المؤسسة التقنية.
- تخطيط وكتابة أدلة استخدام برمجيات بتساعد المستخدم ينفذ مهامه الفعلية، مش بس تشرح الخصائص.
- إعداد وثائق واجهات برمجة تطبيقات تمكّن المطورين من الدمج مع الخدمة من غير الاعتماد على الدعم الداخلي.
- إنتاج ملاحظات إصدار ووثائق مرتبطة بالإصدارات تفضل متزامنة مع تغييرات المنتج عبر الإصدارات المختلفة.
- تنظيم مقالات قاعدة المعرفة حول الأسئلة المتكررة بحيث تقدر فرق الدعم تعيد استخدامها.
- تطبيق دليل أسلوب للتوثيق يحافظ على اتساق المصطلحات والنبرة بين عدة كتّاب.
- تصميم هندسة معلومات تخلّي مستودعات التوثيق الكبيرة قابلة للبحث والتنقل.
- إدارة مسارات مراجعة التوثيق واعتماده وحوكمته.
- دمج التوثيق في عمليات تطوير البرمجيات وإدارة المنتجات ودعم العملاء.
الفئة المستهدفة
- الكتّاب التقنيون ومتخصصو التوثيق.
- مطورو البرمجيات والفرق الهندسية اللي بتساهم في وثائق واجهات البرمجة والمراجع التقنية.
- مديرو المنتجات المسؤولون عن التواصل حول الإصدارات ومحتوى دورة حياة المنتج.
- مديرو تقنية المعلومات وقادة التقنية اللي بيؤسسوا حوكمة للتوثيق.
- متخصصو دعم العملاء وضمان الجودة وإدارة المعرفة.
- محللو الأعمال ومتخصصو التنفيذ اللي بيحولوا الوظائف التقنية لإرشادات.
3محتوى البرنامج
المحور الأول: التوثيق الضعيف بيكلّف فريق الدعم قد إيه فعلياً
- إزاي تذاكر الدعم المتكررة بترجع لمحتوى ناقص أو قديم.
- لماذا التوثيق منتج ينبغي التعامل معه بجدية، مش فكرة لاحقة.
- إدارة دورة حياة التوثيق من الإنشاء حتى الإيقاف.
المحور الثاني: وضع الأساسيات - النطاق والملكية والجودة
- تحديد المستخدمين ومتطلباتهم من المعلومات.
- ملكية التوثيق وتخطيطه وسير عمل إنتاجه.
- معايير جودة المحتوى ودقته.
المحور الثالث: كتابة أدلة استخدام برمجيات يستخدمها الناس فعلاً
- تحديد مهام المستخدم وسير عمله قبل كتابة الإجراءات.
- تنظيم تعليمات المهام وشرح الخصائص وأقسام معالجة المشكلات.
- مراجعة الأدلة للتأكد من الدقة والاكتمال وسهولة الاستخدام.
المحور الرابع: توثيق واجهات البرمجة لمطورين مش هيكلّموك أبداً
- توثيق نقاط الاتصال والأساليب والمعلمات والاستجابات.
- المصادقة ومعالجة الأخطاء وأمثلة الاستخدام العملية.
- الحفاظ على تزامن وثائق واجهة البرمجة مع تغييرات البرمجيات.
المحور الخامس: ملاحظات الإصدار والوثائق المرتبطة بالإصدارات المتزامنة
- توثيق الخصائص الجديدة والتحسينات والمشكلات التي تمت معالجتها.
- تنظيم وثائق الإصدارات المتكررة لجماهير مختلفة.
- إدارة التوثيق عبر إصدارات البرمجيات المتعددة وأرشفة المحتوى القديم.
المحور السادس: تحويل أسئلة الدعم لمقالات قاعدة معرفة
- تحديد متطلبات الدعم المتكررة وأنماط حل المشكلات.
- كتابة إجراءات معالجة الأعطال والإرشادات التشغيلية.
- تنظيم المحتوى بما يسهّل البحث وإيقاف المقالات القديمة.
المحور السابع: أدلة أسلوب بتخلّي كتّاب كتير يبانوا كأنهم واحد
- المصطلحات ومعايير التسمية ومعايير التنسيق.
- النبرة والوضوح ومعايير الكتابة للجمهور التقني.
- إدارة المصطلحات باتساق بين عدة مساهمين.
المحور الثامن: هندسة المعلومات - جعل المحتوى قابلاً للإيجاد
- تسلسل المحتوى وتصنيفه وهياكل التنقل.
- التصنيف والبيانات الوصفية ومسارات المستخدم داخل التوثيق.
- تنظيم المستودعات الكبيرة لتحسين البحث وسهولة الاكتشاف.
المحور التاسع: الحوكمة ودمج التوثيق في سير العمل
- المراجعة والاعتماد والتحقق من الدقة التقنية.
- تدقيق التوثيق ومؤشرات الأداء.
- ربط التوثيق بعمليات التطوير والمنتج والدعم على مستوى المؤسسة.