الكتابة التقنية (2)
(Technical Writing)
كانت الحلقة الأولى عبارة عن تعريف بالكتابة التقنية والكاتب التقني والمهارات المطلوبة، وعددنا فيها بعضاً من أكثر الوثائق شيوعاً في عالم التوثيق للصناعات، وذلك كمدخل لا غنى عنه لإرساء قاعدة أساسية وتكوين تصور للكتابة التقنية خاصة وأن الكثير مما يتعلق بهذه المهنة لا يزال يقع ضمن نطاق المجهول بالنسبة لكثير من قطاعات الأعمال في بلادنا.
ولا بد قبل أن نمضي من اعتماد تعريف رسمي للكتابة التقنية.
1- تعريف
هناك تعاريف عديدة للكتابة التقنية وبعض هذه التعاريف، وخاصة الأمريكية منها، يضع مصطلح الكتابة التقنية تحت مفهوم أوسع قليلاً يدعى "التواصل/الاتصال التقني" أو (Technical Communication). وربما لا يكون الدارس بصدد الاطلاع على كل تلك التعاريف طالما أنها تصب في خانة واحدة في النهاية وإن كان بينها بعض الفروقات.
تعرِّف جمعية الاتصال التقني الأمريكية، وهي من أوائل جمعيات الكتابة التقنية، الكتابة التقنية على أنها "عملية جمع المعلومات من الخبراء وتقديمها لجمهور من القراء في هيئة واضحة وسهلة الفهم."
2- إدارة مشروع الكتابة التقنية
كأي مشروع، تمر الكتابة التقنية بعدة مراحل رئيسية، هي:
الأولى: الدراسة والتخطيط.
الثانية: كتابة المادة.
الثالثة: ضبط الجودة - الفحص والمراجعة والتدقيق.
وقد تنقسم كل مرحلة إلى مراحل فرعية وتنتهي كل مرحلة منها بنتيجة مادية أو "تسليمة" (Deliverable)، فالمرحلة الأولى ينتج عنها التصميم العام للوثيقة المراد كتابتها، وعن الثانية مسودة مادة الوثيقة (Draft) وعن الثالثة الوثيقة النهاية (Final Deliverable).
2-1 المرحلة الأولى: الدراسة والتخطيط
وفيها تتم علميات دراسة الموضوع والبحث فيه وجمع المعلومات والإلمام الشامل بالتفاصيل للخروج بالتصميم الأولي للوثيقة المراد كتابتها. إذا كان الكاتب التقني ملماً تماماً بموضوع الصناعة أو المُنتَج المعني فإنه يبدأ فوراً بجمع المعلومات وتصنيفها وطرح الأسئلة وقراءة الوثائق الفنية الموجودة مثل وثيقة التصميم الرئيسية أو المواصفات. أما إذا لم يكن الكاتب ملماً بالموضوع فإنه يتوجب عليه دراسته وتعلمه من الصفر. في هذه الحالة يجب على الكاتب أن يمر بمرحلة فرعية من مرحلة الدراسة والتخطيط وهي التعرف والإلمام (Familiarization) بالتكنولوجيا أو الموضوع، وقد تُلحقه الشركة بدورات تدريبية.
ويجب أن تأخذ هذه المرحلة مداها كاملاً قبل الانتقال إلى المرحلة التالية، وقد تمتد من أسبوع إلى أشهر عديدة كما هي الحال في تكنولوجيا المعلومات وتطوير البرمجيات الكبيرة.
وقد نتناول هذه المرحلة بالتفصيل في موضوع منفصل تجنباً للتشعب والإطالة هنا.
المهم أن هذه المرحلة تنتهي على الأقل بوثيقة أو تسليمة واحدة، هي التصميم العام للوثيقة المراد كتابتها (دليل المستخدم، دليل المبرمجين، خطة الفحص الرئيسية ... إلخ). وكذلك قد ينتج عنها الخطوط الرئيسية لخطة عمل الكتابة التقنية (انظر 3-1 خطة عمل الكتابة التقنية أدناه)
إلى جانب التصميم العام سيتوفر للكاتب التقني من المرحلة الأولى كم جيد من الملاحظات والوثائق المفيدة وتوصيات مدير المشروع و/أو مدير المُنتج ومتطلبات الزبون، إن وجدت، وإجراءات عمل القطاع المستفيد من النظام/ المُنتج المعني.
2-2 مرحلة كتابة المادة
يبدأ الكاتب أو الكتاب التقنيون، إن كان هناك فريق، بكتابة المادة حسب الخطة الموضوعة (انظر 3-1 خطة عمل الكتابة التقنية أدناه). ويجب أن يرافق عملية الكتابة هنا تشغيلٌ أو استعراض للنظام –إذا كان ذلك منطبقاً- كما هي الحال في وصف عمل الأجهزة أو الأنظمة الآلية وبرمجيات الكمبيوتر.
لا بد وأن يكون هناك مواعيد وتواريخ ومراحل مفصلية (Milestones) حسب الجدول الزمني لخطة الكتابة (أو لخطة المشروع ككل كما في مشاريع تطوير البرمجيات تكون الوثائق التقنية من ضمن تسليماتها). ويجب تحديد مسؤولية تنسيق الإبلاغ عن عمليات التعديل أو التغيير على المنُتج كي يتم تحديث المادة الجاري كتابتها.
قد تنقسم مرحلة الكتابة إلى مراحل فرعية تنتهي كل منها بكتابة فصل أو جزء من أجزاء الوثيقة الرئيسية. وكما ذكرنا تنتهي المرحلة عند اكتمال مسودة الوثيقة (Draft). وسوف نناقش فنيات ومعايير الكتابة في الفصول اللاحقة.
2-3 مرحلة ضبط الجودة: الفحص والمراجعة والتدقيق
بالتعاون مع المصممين أو مسؤولي ضبط وضمان الجودة تجري مراجعة الوثيقة المكتوبة من حيث:
(1) مطابقة الوثيقة لوثيقة التصميم العام المتفق عليها من حيث المحتوى والمواصفات.
(2) سلامة اللغة وسهولة فهم العمليات الموصوفة.
(3) شمول كافة النواحي والعناصر اللازمة للمستخدم المستهدف.
(4) دقة المحتويات وتمثيلها لأحدث وضعية للُمنتج.
وغير ذلك من الجوانب الخاصة بكل مجال عمل أو قطاع، فقد تكون مراعاة النواحي القانونية والأمنية وما إلى ذلك جزء لا يتجزأ من عملية التدقيق وضبط الجودة.
وتنتهي المرحلة بتسليم الوثيقة النهائية حسب الاتفاق.
3- عمليات الكتابة التقنية
إذن، اتفقنا على أن الكتابة التقنية هي فن الوصول إلى المعلومة ومن ثم توصيلها للآخرين. وهي بذلك عملية تتكون بصورة عامة من شقين أساسيين، هما:
(1) جمع واكتشاف المعلومات المتعلقة بمنتج جديد وفهما فهماً كاملاً، و
(2) تقديم تلك المعلومات للمستخدم أو المستفيد أو صاحب المصلحة فيها أياً كان باللغة والتنسيق المناسبين.
أما خطة العمل الخاصة بالكتابة فينبغي أن تشتمل على معظم أو كل البنود التالية بغض النظر عن تعقيد وحجم مشروع الكتابة: ابتداءً من إيجاز أسبوعي عن سير الأعمال ولغاية دليل تشغيل وصيانة لنظام إلكتروني أو آلي كبير.
ملاحظة بالنسبة لمصادر المعلومات: تجدر الملاحظة هنا أنه بالإضافة إلى مجموعة الملاحظات والأوراق التي تراكمت لدي عبر خبرة تسع سنوات من العمل في هذا المجال، فإنني من هذه النقطة فصاعداً قد أستعين بعدة مصادر باللغة الإنجليزية لتدعيم الأفكار الواردة في مادة هذه السلسلة، سأقوم بذكرها في نهاية البحث لمن يحب الاستزادة. أما في حالة النقل المباشر فسوف أذكر المصدر في نفس الصفحة أو الموضع الذي تم النقل فيه.
3-1 خطة عمل الكتابة التقنية
إن نجاح عملية الكتابة العادية أمر فيه صعوبة ويستغرق جهداً ووقتاً حسب كفاءة الكاتب، ونحن نلاحظ هذه الصعوبة في النقاشات التي تدور على منتديات واتا المختلفة وما يعتري عملية الكتابة من مشكلات ومثالب. ويزداد حجم هذه الصعوبة في عملية الكتابة التقنية نظراً لـ:
• التعقيد الذي قد تتسم به التكنولوجيا أو الأنظمة أو الأجهزة أو الموضوعات التي نكتب عنها.
• حساسية المسألة من حيث الدقة وتأثيرها على سلامة استخدام أو تشغيل التقنية المعنية.
وتتألف خطة عمل الكتابة التقنية من الخطوات التالية:
(1) تعريف الهدف من الوثيقة المراد كتابتها.
(2) تحديد الفئة المستهدفة بالوثيقة وجمع المعلومات عنها بما في ذلك مستواها الفني واللغوي والثقافي.
(3) تحديد مستوى التفصيل اللازم للمستخدم.
(4) تنظيم محتويات الوثيقة وكيفية تتسلسل موادها – الفصول والأقسام (تنظيم المحتوى وعناصر التنسيق)
(5) الشروع في كتابة المادة.
(6) مراجعة وتدقيق المادة- ضبط الجودة.
(7) سجل المراجعات وضبط الإصدارات.
وسوف نتعرض في الأقسام التالية لكل بند من هذه البنود بالشرح والتوضيح.
3-1 ما الهدف من الوثيقة؟
تحديد الهدف، أو الأهداف، من تأليف وثيقة تقنية ما هو الخطوة الأولى في خطة الكتابة، وكلما كان الهدف واضحاً ومحدداً كلما كانت الخطوات التالية أكثر نجاحاً؛ فالعملية كلها أصلاً تدور حول الغاية من عملية كتابة الوثيقة، أي الفائدة العملية التي تترتب على وجود الوثيقة.
لنفترض أننا نكتب دليلاً لمستخدمي منتديات الجمعية الدولية للمترجين واللغويين العرب (واتا)، فما الهدف من هذه الوثيقة؟
الهدف هو: "شرح عمليات استخدام منتديات واتا".
يوصي خبراء إدارة المشاريع أن يكون الهدف محدداً وقابلاً للقياس. وبالتالي فإن الصياغة أعلاه للهدف شديدة العمومية وبالتالي سيصعب تقييم الوثيقة من حيث تحقيقها للهدف المنشود. يمكننا إذن صياغة الهدف على النحو التالي:
"توفير المعلومات اللازمة كي يتمكن مستخدم المنتديات من قراءة المواضيع والتعليق عليها ونشر مشاركات جديدة واستخدام كافة الوظائف والمزايا التي يوفرها المنتدى بصورة فعالة"
3-2 من سيستخدم الوثيقة؟
لا يمكن للكتابة التقنية أن تنجح بالمستوى اللائق ما لم تكن:
- موجهة إلى جمهور بعينه (وهم في مثالنا السابق أعضاء واتا (الجدد تحديداً))،
- تأخذ بعين الاعتبار مستوى ذلك الجمهور الثقافي والدراسي والفني،
- تستخدم اللغة والأسلوب الملائمين لذلك المستوى.
فعندما تكتب ملخصاً فنياً موجهاً لهيئة مهندسي التصميم في شركة برمجيات فلا بد أنك ستستخدم لغة فنية عالية ونسب وأرقام ومواصفات فنية، وعندما تكتب تقريراً بالحالة للمدير العام فإنك ستستخدم لغة غير تقنية وستورد نتائج وإحصائيات وأرقام بالكلف وتأثيرها على الأمور وقد تدعم معلوماتك برسومات بيانية وتقييمات وتوصيات تتعلق بالمرحلة القادمة.
بم يفيدني معرفة كل تلك المعلومات عن جمهور قراء/مستخدمي الوثيقة؟
كنا في إحدى الحالات بصدد كتابة أدلة مستخدمين لحزمة برامج إلكترونية مباعة لشركات في دول خليجية. وكان السؤال هل نكتبها بالعربية أم بالإنجليزية؟ ولما تبين أن الغالبية العظمى من المستخدمين (الموظفين والفنيين) هم من جنسيات آسيوية غير عربية تقرر أن تكون لغة مجموعة الكتيبات باللغة الإنجليزية.
إذن، مسألة معرفة جمهورك وثقافته وخلفيته العلمية وجنسيته وتقديرك للنواحي الفنية والسيكولوجية التي يجب أن تأحذها بعين الاعتبار عند اختيارك للغة وأسلوب الكتابة هي مسألة غاية في الأهمية. فأنت بلا شك لا تريد أن توضع الوثائق التي تكتبها على الرف مهملة، ولا أن يتوقف الزبائن شراء منتجات شركتك بسبب رداءة الوثائق ذات الصلة.
كما ويفيد معرفة المستخدمين للوثيقة في:
- لغة الوثيقة وأسلوب الكتابة وتقديم المعلومات.
- انتقاء المصطلحات والمفردات المناسبة، فأنت لا تخاطب المستخدم العادي في "دليل المستخدم" بنفس المصطلحات التي تخاطب بها المبرمج في "دليل المبرمجين".
- المحتوى بما في ذلك مستوى التفاصيل الواجب توفيرها كما سنوضح في القسم التالي.
في بعض الأحيان، لا يكون جمهور المستهدفين من الوثيقة متجانساً أو أن الوثيقة تخاطب عدة فئات بينها فروقات كبيرة، فما العمل؟
في الواقع، هناك حلول عدة تفرضها طبيعة وخصوصية كل حالة، منها أن تقسم الوثيقة إلى فصول يخاطب كل فصل منها فئة معينة؛ كأن يكون الفصل الأول عبارة عن ملخص وظيفي للإداريين عن الموضوع، ويكون الثاني متعلقاً بتعليمات استخدام أو تشغيل النظام، والثالث لصيانته وفكه وتركيبه مع مخططات هندسية للفنيين والمهندسين وهكذا دواليك.
3-3 مستوى التفاصيل
عندما يصبح بين يدي الكاتب التقني الإجابة الكاملة عن السؤالين السابقين يصبح ممكناً تحديد مستوى التفاصيل اللازم إدراجها في الوثيقة؛ أي ما الذي يجب أن أُطلع المستهدفين بالوثيقة عليه وما الذي سأحجبه عنهم؟ وهذه قضية كبيرة وحاسمة في كتابة وثيقة مؤثرة وفعالة، ولكنها مسألة خادعة أيضاً. وقد يقع الكاتب التقني قليل الخبرة في بدايات حياته المهنية في خطأ تغطية كافة المعلومات التي يعرفها عن الموضوع ظناً منه أن في الاسترسال فائدة.
مثال:
تخيل جزءاً من برنامج يقوم بعملية حسابية لإدخالات متعددة. اقرأ الفقرة التالية:
"كي يقوم البرنامج بعملية حسابية صحيحة لإجمالي القيود المدخلة يجب أن يتم "تصفير" القيم في جدول الأقساط (مثلاً) من الجدول الرئيسي في قاعدة البيانات وإعادة ضبط عمود العداد بإضافة +1 للقيم السابقة مع حفظ تفاصيل الإدخال السابق منفصلة في جدول "القيود". كي يتم ذلك يجب أن يتم حفظ بيانات القيد عند الانتهاء من إدخاله. والسبب في ذلك أن روتين التدقيق على .... لا ينطلق إلا إذا تمت عملية الحفظ. لذا يجب إجبار المستخدم على الحفظ بإحدى الطرق التالية: ..."
المعلومة أعلاه تحمل تفاصيل مصدرها مصمم البرمجيات ويجب أن يعرفها محلل النظم مثلاً وأن يقرأها المبرمج وينفذها عند كتابته للكود. كل ذلك يتم خلف شاشة أو واجهة التفاعل التي يراها المستخدم ولا حاجة به كي يعرف عنها شيئاً لأنها قد تربكه وتشوشه. فلا معنى إذاً لإطلاعه عليها، وكل ما يجب أن نقوله للمستخدم في هذه الحالة هو:
"عند الانتهاء من إدخال معلومات كل قيد، اضغط مفتاح Save".
وعند مفتاح "الحفظ" نتوقف ونترككم في حفظ الله لفترة لن تطول بإذن الله.
في الحلقة الثالثة سنبدأ بمشيئة الله بالخطوة الرابعة: "3-4 تنظيم محتويات الوثيقة وكيفية تتسلسل موادها".
مع التحية وأمنيات التوفيق من الله،،
أحمد الفهد
