نظرة عامة على البرنامج
مقدمة:
دورة الكتابة التقنية وتوثيق المنتجات دورة تمتد 5 أيام، موجهة لكتاب المحتوى التقني والمهندسين وفرق المنتجات، وتنتهي بإعداد خطة توثيق المنتج مع مجموعة موضوعات نموذجية لمنتج افتراضي. فكثير من الجهات تطرح منتجاتها بأدلة منقولة من طرازات سابقة، وصفحات مساعدة تخالف واجهة الاستخدام، ونسخ عربية تتأخر عن الإصدار الإنجليزي، فترتفع اتصالات الدعم وحالات الإرجاع. ويتولى المشاركون فعلا صياغة أدلة المستخدم أو أدلة التشغيل والصيانة أو المساعدة الإلكترونية، ويعملون على دراسات حالة مبنية على محتوى منتجات حقيقية. وتقدم كور كونسبت هذه الدورة في الكتابة التقنية وتوثيق المنتجات.
أهداف الدورة:
- تحليل فئات مستخدمي المنتج وتفكيك أهدافهم إلى مهام تحدد موضوعات دليل المستخدم والدليل الفني والمساعدة الإلكترونية التي يحتاجها كل إصدار
- إعادة هيكلة الأدلة الصفحية إلى موضوعات مفاهيم ومهام ومراجع تجمع عبر خرائط DITA لمخرجات الطباعة والمساعدة
- تطبيق دليل أسلوب مؤسسي وقواعد اللغة المضبوطة في ASD-STE100 ليقرأ محتوى المنتج بمعنى واحد ويترجم بسهولة
- تخطيط لقطات الشاشة والرسوم المشروحة والمناظر المفككة والمقاطع المصورة القصيرة التي توضح الخطوات أكثر من النص وحده
- إدارة المصدر الواحد والتصفية المشروطة وجولات المراجعة وترقيم الإصدارات ليخدم مصدر واحد عدة طرازات من المنتج
- إعداد النسختين العربية والإنجليزية بقاعدة مصطلحات وفحوص تخطيط من اليمين إلى اليسار ومؤشرات توثيق تبين نجاح المستخدمين في مهامهم
الفئة المستهدفة:
- فرق الكتابة التقنية المسؤولة عن أدلة المستخدم وأدلة التركيب والمساعدة الإلكترونية للأجهزة والبرمجيات والمعدات
- فرق الهندسة والتصميم المسؤولة عن تزويد المحتوى الفني ومراجعته في أدلة التشغيل والصيانة
- أعضاء فرق المنتجات والمشاريع المسؤولون عن ملاحظات الإصدار ووصف الخصائص واعتماد التوثيق عند الإطلاق
- فرق دعم العملاء والتدريب المسؤولة عن مقالات مركز المساعدة وبطاقات البدء السريع ومواد تهيئة المستخدمين
- فرق الترجمة والتوطين المسؤولة عن النسختين العربية والإنجليزية من محتوى المنتج
- منسقو التوثيق المسؤولون عن مستودعات المحتوى والقوالب ومسارات المراجعة وخطط النشر
محاور الدورة:
اليوم 1: منظومة توثيق المنتج وتحليل مهام المستخدم
- خريطة مجموعة وثائق المنتج من دليل البدء السريع إلى دليل التشغيل والصيانة
- بطاقة شخصيات المستخدمين للمشغلين وفنيي التركيب وفنيي الخدمة
- التحليل الهرمي للمهام وتحويل أهداف المستخدم إلى قوائم موضوعات
- جرد محتوى دليل منتج قائم وتدقيق فجواته
- تحليل تذاكر الدعم لاكتشاف محتوى المساعدة الناقص
اليوم 2: نماذج التأليف القائم على الموضوعات والتأليف المنظم
- مقارنة أنواع موضوعات DITA للمفاهيم والمهام والمراجع
- خرائط DITA لترتيب الموضوعات في الأدلة والمساعدة
- التأليف بنموذج Lightweight DITA ولغة Markdown لفرق المنتجات الصغيرة
- قواعد حجم الموضوع وكتابة موضوعات مستقلة بأقل سياق
- تصميم نموذج المعلومات لمحفظة وثائق المنتجات
اليوم 3: كتابة أدلة المستخدم وموضوعات المساعدة والمرئيات
- كتابة موضوع المهمة بالمتطلبات المسبقة والخطوات والنتائج
- تطبيق قواعد الكتابة في ASD-STE100 على تعليمات المنتج
- بناء دليل الأسلوب المؤسسي للمصطلحات والنبرة والتنسيق
- تخطيط لقطات الشاشة والتعليقات التوضيحية والمناظر المفككة
- رسائل السلامة والملاحظات ورموز المخاطر في أدلة المستخدم
اليوم 4: إعادة استخدام المحتوى وضبط المراجعة والتوطين بين العربية والإنجليزية
- إعادة الاستخدام بالإحالة والمفاتيح للتحذيرات والمواصفات المشتركة
- سمات التصفية المشروطة لطرازات المنتج وفئات الجمهور
- جولات مراجعة التوثيق بقوائم تحقق خبراء الموضوع
- ترقيم الإصدارات وسجلات التغيير واستراتيجية فروع التوثيق
- قاعدة المصطلحات العربية وتخطيط اليمين إلى اليسار وفحوص جاهزية الترجمة
اليوم 5: دراسة حالة وخطة توثيق المنتج
- مراجعة موجز المنتج محل الحالة ومصفوفة مهام المستخدم
- مجموعة موضوعات مهام ومراجع نموذجية للمنتج محل الحالة
- مخطط إعادة الاستخدام وتصفية الطرازات لنموذجين من المنتج
- مجموعة مؤشرات التوثيق لنجاح المهام وسهولة العثور بالبحث
- استكمال خطة توثيق المنتج والدفاع عنها في مراجعة الأقران
المهارات التي ستكتسبها:
- تحليل مهام المستخدم
- التأليف القائم على الموضوعات
- تصميم نموذج المعلومات
- الكتابة باللغة المضبوطة
- تخطيط الرسوم التقنية
- إعادة استخدام المحتوى من مصدر واحد
- توطين التوثيق
- قياس جودة التوثيق
لماذا تحضر هذه الدورة:
- إعداد خطة توثيق المنتج مع مجموعة موضوعات نموذجية ورفعها إلى مدير المنتج وقائد الهندسة ورئيس الدعم الذين يعتمدون محتوى الإصدار
- تحديد الأدلة التي يعاد هيكلتها إلى موضوعات قابلة لإعادة الاستخدام، والطرازات التي تصفى من مصدر واحد، والمحتوى الذي يسحب
- تجنب طرح أدلة تخالف المنتج ونسخ عربية تتأخر عن الإصدار الإنجليزي واتصالات دعم سببها خطوات ناقصة
- نقل بطاقة الشخصيات ودليل الأسلوب وقوالب الموضوعات وقائمة المراجعة إلى الكتاب والمهندسين والمترجمين عبر خط المنتجات
الخاتمة:
بعد العودة إلى العمل يقدم المشارك خطة توثيق المنتج إلى مدير المنتج وقائد الهندسة ورئيسي الدعم والتوطين. وتعتمد هذه الجهات على الخطة في إقرار هيكل الموضوعات ومخطط إعادة الاستخدام والطرازات ودليل الأسلوب ومسار المراجعة للإصدار القادم، وفي تمويل تحويل الأدلة ذات الأولوية. وبعد أول إصدار يوثق وفق الخطة، يقارن الفريق اتصالات الدعم ونجاح البحث ومدة دورة المراجعة بخط الأساس، ثم يحدث قوالب الموضوعات وقاعدة المصطلحات والمؤشرات.
الأسئلة الشائعة:
ما الذي يحتاجه المشارك قبل دورة الكتابة التقنية وتوثيق المنتجات؟
يحتاج المشارك إلى خبرة في صياغة أدلة المستخدم أو الأدلة الفنية أو المساعدة الإلكترونية لمنتج ما أو مراجعتها، ولا تشترط معرفة بلغة XML أو البرمجة. ويفيده إحضار حاسوب محمول ومقتطف مجهول الهوية من دليل أو صفحة مساعدة حالية لتقريب تمارين الحالة من عمله.
بم تختلف دورة الكتابة التقنية وتوثيق المنتجات عن دورات كتابة التقارير أو كتابة الإجراءات؟
توثق هذه الدورة المنتجات لمستخدميها: أدلة وموضوعات مساعدة وأدلة بدء سريع تبنى من موضوعات قابلة لإعادة الاستخدام وتوطن. أما دورات كتابة التقارير فتعرض النتائج لمتخذي القرار، وتوثق دورات الإجراءات العمليات الداخلية أو مهام الصيانة للموظفين.
لماذا يعتمد توثيق المنتجات على التأليف المنظم القائم على الموضوعات مثل DITA؟
لأن التأليف القائم على الموضوعات يكتب كل مفهوم أو مهمة أو مرجع مرة واحدة ثم يجمعه في عدة أدلة ومخرجات مساعدة. وتقلل إعادة الاستخدام وتصفية الطرازات النصوص المكررة، وتحافظ على اتساق الطرازات، وتخفض حجم الترجمة لكل نسخة لغوية جديدة.
ماذا يعود به المشارك من دورة الكتابة التقنية وتوثيق المنتجات؟
يعود المشارك بخطة توثيق المنتج لمنتج افتراضي، تضم مصفوفة مهام المستخدم وموضوعات نموذجية بأسلوب DITA ومخطط دليل الأسلوب ومخطط إعادة الاستخدام والتصفية وقائمة مراجعة وقائمة تحقق للتوطين العربي ومجموعة مؤشرات للتوثيق.