ملاحظات:

يركّز هذا الفصل على أحد أهم استخدامات الكتابة التقنية على الإطلاق—وهو التعليمات. وكما تعلم، فإن التعليمات هي تلك الشروحات المتتابعة خطوة بخطوة لكيفية إنجاز شيء ما: كيفية البناء، أو التشغيل، أو الإصلاح، أو الصيانة.

تأكّد من الاطلاع على الأمثلة .

هل تكتب مجموعة تعليمات للعمل أو لمقرر في الكتابة التقنية؟ جرّب هذا دليل تخطيط التعليمات.

كتابة التعليمات<

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

وفي النهاية، تتطلّب كتابة التعليمات الجيدة ما يلي:

بحلول هذه المرحلة، من المحتمل أنك درست العناوين، والقوائم، والإشعارات الخاصة—وقد يبدو لك أن كتابة مجموعة تعليمات باستخدام هذه الأدوات أمر بديهي. فقط قسّم النقاش إلى قوائم رأسية مرقّمة، وأضف بعض الإشعارات الخاصة في المواضع الواضحة، وتنتهي المهمة! حسنًا، ليس تمامًا، لكنه بداية ممتازة. يستكشف هذا الفصل بعض خصائص التعليمات التي قد تجعلها أكثر تعقيدًا، ويمكنك بدورك استخدام هذه الاعتبارات لتخطيط تعليماتك الخاصة.

مخطط معلوماتي أُنشئ بواسطة NotebookLM لهذا الفصل

مخطط معلوماتي أُنشئ بواسطة NotebookLM لهذا الفصل

بعض المقدمات<

في بداية مشروع كتابة التعليمات، من المهم تحديد البنية أو الخصائص للإجراء المحدد الذي ستكتب عنه.

الجمهور والسياق. في وقت مبكر من العملية، حدّد جمهور تعليماتك وسياقها. تذكّر أن تحديد الجمهور يعني تحديد مستوى إلمامه بالموضوع، إضافة إلى تفاصيل أخرى مشابهة. راجع مناقشة الجماهير والخطوات المستخدمة في تعريفها.

والأهم من ذلك، إذا كنت في مقرر للكتابة، فستحتاج إلى كتابة وصف لجمهورك وإرفاقه بتعليماتك. يتيح ذلك لمعلّمك تقييم تعليماتك من حيث ملاءمتها للجمهور المستهدف. وتذكّر أيضًا أنه في مقررات الكتابة التقنية يُفضَّل الكتابة لجماهير غير متخصصة—وهو تحدٍّ أكبر لك ككاتب.

عدد المهام. كم عدد المهام الموجودة في الإجراء الذي تكتب عنه؟ لنستخدم مصطلح الإجراء للإشارة إلى مجموعة الأنشطة الكاملة التي تهدف تعليماتك إلى مناقشتها. أمّا المهمة فهي مجموعة شبه مستقلة من الأفعال ضمن الإجراء؛ على سبيل المثال، ضبط الساعة في فرن الميكروويف يُعد مهمة واحدة ضمن الإجراء العام لتشغيل فرن الميكروويف.

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

تحتوي بعض التعليمات على مهمة واحدة فقط، ولكن تتضمن العديد من الخطوات داخل تلك المهمة الواحدة. على سبيل المثال، تخيّل مجموعة تعليمات لتجميع أرجوحة للأطفال. في تجربتي الشخصية، كان هناك أكثر من 130 خطوة! قد يكون ذلك أمرًا مربكًا. ومن الأساليب الجيدة تجميع الخطوات المتشابهة والمرتبطة في مراحل، ثم إعادة ترقيم الخطوات مع كل مرحلة جديدة. وتُعد المرحلة مجموعة من الخطوات المتشابهة ضمن إجراء ذي مهمة واحدة. في مثال الأرجوحة، يكون إعداد الإطار مرحلة؛ وتثبيته في الأرض مرحلة أخرى؛ وتجميع المقعد مرحلة ثالثة.

علامة اقتباس افتتاحية استخدم التوجّه القائم على المهام. ركّز على المهام التي يريد قرّاؤك تنفيذها؛ واستخدم صياغات «كيفية» أو صياغات تنتهي بـ –ing في العناوين. علامة اقتباس ختامية

أفضل نهج لمناقشة الخطوات خطوة بخطوة. من الاعتبارات الأخرى—والتي قد لا تتمكن من تحديدها مبكرًا—كيفية تركيز تعليماتك. في معظم التعليمات، يمكنك التركيز على المهام، أو يمكنك التركيز على الأدوات (أو ميزات الأدوات).

في نهج المهام (ويُعرف أيضًا بالتوجّه القائم على المهام) لتعليمات استخدام خدمة الرد على الهاتف، ستكون لديك الأقسام التالية:

هذه مهام—وهي الأشياء النموذجية التي نرغب في القيام بها باستخدام الجهاز. لمزيد من النقاش، راجع الفصل الخاص بـ تحليل المهام.

ومن ناحية أخرى، في نهج الأدوات لتعليمات استخدام آلة تصوير المستندات، ستكون هناك أقسام غير محتملة مثل:

إذا صمّمت مجموعة تعليمات وفق هذا النهج، فستكتب خطوات لاستخدام كل زر أو ميزة في آلة التصوير. من الصعب جعل التعليمات التي تستخدم نهج الأدوات فعّالة. ففي بعض الأحيان لا يتطابق اسم الزر تمامًا مع المهمة المرتبطة به؛ وأحيانًا تحتاج إلى استخدام أكثر من زر واحد لإنجاز المهمة. ومع ذلك، قد تكون هناك حالات يُفضَّل فيها نهج الأدوات/الميزات.

تجميع المهام. قد لا يكون سرد المهام كافيًا. فقد يكون عدد المهام كبيرًا لدرجة تستلزم تجميعها بحيث يتمكن القرّاء من العثور على المهام الفردية بسهولة أكبر. على سبيل المثال، فيما يلي تجميعات شائعة للمهام في التعليمات:

  1. مهام التفريغ والإعداد
  2. مهام التثبيت والتخصيص
  3. مهام التشغيل الأساسية
  4. مهام الصيانة الروتينية
  5. مهام استكشاف الأخطاء وإصلاحها، وهكذا

الأقسام الشائعة في التعليمات<

فيما يلي مراجعة للأقسام التي ستجدها عادةً في التعليمات. لا تفترض أن كل واحد منها يجب أن يكون موجودًا في التعليمات التي تكتبها فعليًا، ولا أنها يجب أن تكون بالترتيب المعروض هنا، ولا أن هذه هي الأقسام الوحيدة الممكنة في مجموعة تعليمات.

أثناء قراءتك للأقسام الشائعة في التعليمات، اطّلع على نماذج التعليمات.

عرض تخطيطي للتعليمات.
عرض تخطيطي للتعليمات. تذكّر أن هذا نموذج نموذجي أو شائع لمحتويات التعليمات وتنظيمها—وهناك العديد من النماذج الأخرى الممكنة.

المقدمة. خطّط لمقدمة تعليماتك بعناية. تأكّد من أنها تقوم بأي مما يلي (ليس بالضرورة بهذا الترتيب) مما ينطبق على تعليماتك الخاصة:

راجع القسم الخاص بـ المقدمات لمزيد من النقاش.

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

الخلفية التقنية أو النظرية. في بداية أنواع معينة من التعليمات (بعد المقدمة بالطبع)، قد تحتاج إلى مناقشة خلفية متعلقة بالإجراء. في بعض التعليمات، تكون هذه الخلفية ضرورية—وإلا فلن تكون خطوات الإجراء منطقية. على سبيل المثال، ربما كانت لديك تجربة مع تلك التطبيقات البرمجية التي تتيح لك تحديد الألوان عن طريق تحريك أشرطة تمرير الأحمر والأخضر والأزرق. لفهم ما تفعله حقًا، تحتاج إلى بعض الخلفية حول الألوان. وبالمثل، يمكنك أن تتخيّل أنه في بعض التعليمات المتعلقة باستخدام الكاميرات، قد تكون هناك حاجة إلى بعض النظرية أيضًا.

المعدات واللوازم. لاحظ أن معظم التعليمات تتضمن قائمة بالأشياء التي تحتاج إلى جمعها قبل البدء في الإجراء. يشمل ذلك المعدات، أي الأدوات التي تستخدمها في الإجراء (مثل أوعية الخلط، والملاعق، وقوالب الخبز، والمطارق، والمثاقب، والمناشير)، واللوازم، أي الأشياء التي تُستهلك أثناء الإجراء (مثل الخشب، والطلاء، والزيت، والدقيق، والمسامير). في التعليمات، تُدرج هذه العناصر عادةً إما في قائمة رأسية بسيطة أو في قائمة من عمودين. استخدم القائمة ذات العمودين إذا كنت بحاجة إلى إضافة بعض المواصفات لبعض العناصر أو كلها—مثل أسماء العلامات التجارية، والأحجام، والكميات، والأنواع، وأرقام الطرازات، وما إلى ذلك.

مناقشة الخطوات. عند الوصول إلى كتابة الخطوات الفعلية، هناك عدة أمور يجب وضعها في الاعتبار: (1) بنية وتنسيق تلك الخطوات، (2) المعلومات التكميلية التي قد تكون مطلوبة، و(3) وجهة النظر وأسلوب الكتابة العام.

البنية والتنسيق. عادةً ما نتخيّل مجموعة التعليمات على أنها مُنسّقة على شكل قوائم رأسية مرقّمة—وهو ما يحدث بالفعل في معظم الحالات. عادةً ما تُنسّق تعليماتك خطوة بخطوة بهذه الطريقة. ومع ذلك، توجد بعض الاختلافات وبعض الاعتبارات الأخرى:

انظر الفصل الخاص بـ القوائم لمعرفة الأسلوب والتنسيق المناسبين لهذه الاحتمالات.

مناقشة تكميلية. في كثير من الأحيان، لا يكفي مجرد إخبار القرّاء بأن يفعلوا هذا أو ذاك. فهم بحاجة إلى معلومات تفسيرية إضافية، مثل: كيف يجب أن يبدو الشيء قبل تنفيذ الخطوة وبعدها؛ ولماذا ينبغي عليهم الاهتمام بتنفيذ هذه الخطوة؛ وما هو المبدأ الميكانيكي الكامن وراء ما يقومون به؛ بل وحتى شرح أكثر تفصيلاً على مستوى أدق للخطوة نفسها — أي مناقشة الإجراءات المحددة التي تتكوّن منها الخطوة.

غير أن المشكلة في المناقشة التكميلية هي أنها قد تُخفي الخطوة الفعلية. فأنت تريد أن تبرز الخطوة نفسها — أي الإجراءات المحددة التي يُطلب من القارئ تنفيذها — لا أن تُدفن في كومة من الكلمات. هناك على الأقل تقنيتان لتجنب هذه المشكلة: يمكنك فصل التعليمات عن الشرح في فقرات مستقلة؛ أو يمكنك تمييز التعليمات بالخط العريض.<

تمييز خطوات المستخدم الفعلية في التعليمات.
يساعد النص الغامق على التمييز بين الإجراء الفعلي والمعلومات التكميلية.

علامة اقتباس افتتاحية تجنّب الأسلوب البرقي — أي حذف أدوات التعريف المفهومة ضمنيًا (the، a، an). صحيح أن الروبوتات تكتب بهذه الطريقة، لكننا لسنا مضطرين إلى ذلك. Closing quotation mark

أسلوب الكتابة. قد يبدو أسلوب كتابة التعليمات، جملةً بعد جملة، متناقضًا مع ما علّمته لك دروس الكتابة السابقة. ولكن لاحظ كيف تُكتب التعليمات في "العالم الحقيقي" — فهي تستخدم كثيرًا أسلوب الأمر (أو الخطاب المباشر)؛ وتستخدم كثيرًا كلمة "أنت". وهذا أمر مناسب تمامًا. فأنت تريد جذب انتباه القارئ بالكامل. ولهذا السبب، تبدو جمل التعليمات مثل: "الآن، اضغط زر الإيقاف المؤقت الموجود على اللوحة الأمامية لإيقاف العرض مؤقتًا" و"يجب أن تكون حذرًا حتى لا ...".

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

ومن المشكلات الشائعة الأخرى في أسلوب كتابة التعليمات رغبة الكُتّاب في حذف أدوات التعريف: "اضغط زر الإيقاف المؤقت على اللوحة الأمامية لإيقاف العرض مؤقتًا" أو "يا كائن الأرض، الرجاء تزويدنا بعنوان أقرب مطعم بيتزا." لماذا نفعل هذا؟ هل نرغب جميعًا سرًا في أن نكون روبوتات؟ على أي حال، تأكد من تضمين جميع أدوات التعريف (a، an، the) وغيرها من الكلمات التي نستخدمها عادة في التعليمات.

الرسومات في التعليمات

ربما أكثر من أي نوع آخر من الكتابة (باستثناء القصص المصوّرة)، تُعد الرسومات ضرورية في التعليمات. ففي بعض الأحيان، تعجز الكلمات وحدها عن شرح الخطوة. وغالبًا ما تكون الرسوم التوضيحية أساسية لقدرة القرّاء على تصوّر ما يُطلب منهم القيام به.

في مقررات الكتابة التقنية، قد يُطلب منك تضمين رسوم توضيحية أو أنواع أخرى من الرسومات — أي ما يُستخدم عادة في مثل هذه التعليمات. والمشكلة، بالطبع، أنك قد لا تملك رسومات مناسبة، أو أنك لا تثق كثيرًا في قدراتك الفنية. لكن هناك طرقًا للتغلب على هذه المشكلات! ألقِ نظرة على الاقتراحات الواردة في فصل الرسومات. ستجد هناك اقتراحات لإنشاء الرسومات، إضافةً إلى متطلبات تنسيقها.

التنسيق في التعليمات

العناوين. احرص في تعليماتك على الاستخدام الجيد للعناوين. فعادةً، ستحتاج إلى عناوين لقسم الخلفية، وقسم المعدات واللوازم، وعنوان عام لقسم التعليمات نفسها، وعناوين فرعية للمهام الفردية أو المراحل المختلفة. انظر إلى الأمثلة في بداية هذا الفصل. راجع فصل العناوين للاطلاع على المتطلبات الشائعة.

القوائم. وبالمثل، تعتمد التعليمات اعتمادًا كبيرًا على القوائم، لا سيما القوائم الرأسية المرقّمة لشرح الخطوات خطوةً بخطوة. كما تُعد القوائم البسيطة أو القوائم ذات العمودين مناسبة لقسم المعدات واللوازم. وتفيد القوائم داخل الجملة عند تقديم نظرة عامة. راجع فصل القوائم للاطلاع على المتطلبات الشائعة.

الإشعارات الخاصة. في التعليمات، يجب تنبيه القرّاء إلى الحالات التي قد يتسببون فيها بإتلاف المعدات، أو هدر المواد، أو فشل الإجراء بالكامل، أو إيذاء أنفسهم أو الآخرين — حتى إصابات خطيرة أو مميتة. لقد رُفعت دعاوى قضائية ضد شركات بسبب غياب هذه الإشعارات، أو سوء صياغتها، أو وضعها في أماكن غير مناسبة. راجع فصل الإشعارات الخاصة لمناقشة كاملة حول استخدامها وتنسيقها ومكانها داخل التعليمات.

الأرقام والاختصارات والرموز. تستخدم التعليمات أيضًا الكثير من الأرقام والاختصارات والرموز. راجع الإرشادات الخاصة بهذه الجوانب.

محاذاة الإشعارات في التعليمات. في المثال الأول، لاحظ كيف تُحاذى الإشعارات مع نص الخطوة السابقة. وفي المثال الثاني، لاحظ كيف وُضع الإشعار الشديد في البداية قبل أي خطوات.

  1. مهام فكّ التغليف والإعداد
  2. مهام التثبيت والتخصيص
  3. مهام التشغيل الأساسية
  4. مهام الصيانة الدورية
  5. مهام استكشاف الأخطاء وإصلاحها؛ وما إلى ذلك

الأقسام الشائعة في التعليمات

فيما يلي مراجعة للأقسام التي ستجدها عادةً في التعليمات. لا تفترض أن كل قسم منها لا بد أن يوجد في التعليمات التي تكتبها، ولا أن ترتيبها يجب أن يكون كما هو معروض هنا، ولا أن هذه هي الأقسام الممكنة الوحيدة في مجموعة من التعليمات.

وأنت تقرأ ما يلي عن الأقسام الشائعة في التعليمات، ألقِ نظرة على نماذج التعليمات.

Diagram of instructions format
عرضٌ تخطيطي للتعليمات. تذكّر أن هذا نموذجٌ نموذجي/شائع للمحتوى والتنظيم—ويمكن وجود نماذج أخرى كثيرة.

المقدمة. خطّط لمقدمة تعليماتك بعناية. وتأكد من أنها تقوم بأيٍّ من الأمور التالية (ليس بالضرورة بهذا الترتيب) مما ينطبق على تعليماتك:

انظر قسم المقدمات لمزيد من المناقشة.

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

خلفية تقنية أو نظرية. في بداية بعض أنواع التعليمات (بعد المقدمة بالطبع)، قد تحتاج إلى مناقشة لخلفية تتعلق بالإجراء. وفي بعض التعليمات تكون هذه الخلفية حاسمة—وإلا فلن تبدو خطوات الإجراء ذات معنى. على سبيل المثال، ربما جرّبت تطبيقات برمجية تُعرِّف فيها ألوانك الخاصة عبر تحريك أشرطة الانزلاق للأحمر والأخضر والأزرق. ولكي تفهم حقًا ما الذي تفعله، تحتاج إلى خلفية عن الألوان. وبالمثل، يمكنك تخيّل أن بعض التعليمات التي تستخدم الكاميرات قد تتطلب شيئًا من النظرية أيضًا.

المعدات والمواد الاستهلاكية. لاحِظ أن معظم التعليمات تتضمن قائمة بالأشياء التي تحتاج إلى جمعها قبل أن تبدأ الإجراء. ويشمل ذلك المعدات، أي الأدوات التي تستخدمها في الإجراء (مثل أوعية الخلط، والملاعق، وقوالب الخبز، والمطارق، والمثاقب، والمناشير) والمواد أو المستلزمات، أي الأشياء التي تُستهلك أثناء الإجراء (مثل الخشب، والطلاء، والزيت، والدقيق، والمسامير). في التعليمات تُعرض هذه الأشياء عادةً إما في قائمة رأسية بسيطة أو في قائمة ذات عمودين. استخدم قائمة العمودين إذا احتجت لإضافة مواصفات لبعض العناصر أو كلها—مثل أسماء العلامات التجارية، والمقاسات، والكميات، والأنواع، وأرقام الطراز، وما إلى ذلك.

مناقشة الخطوات. عندما تصل إلى كتابة الخطوات نفسها، فهناك عدة أمور ينبغي تذكّرها: (1) بنية هذه الخطوات وتنسيقها، (2) المعلومات المساندة التي قد تكون مطلوبة، و(3) زاوية السرد وأسلوب الكتابة العام.

البنية والتنسيق. عادةً نتخيّل التعليمات بصيغة قوائم رأسية مُرقّمة. ومعظم التعليمات بالفعل كذلك. وغالبًا ما تُنسّق تعليماتك الفعلية خطوةً بخطوة بهذه الطريقة. ومع ذلك، توجد بعض التنويعات وبعض الاعتبارات الأخرى:

انظر فصل القوائم لمعرفة أسلوب وتنسيق هذه الاحتمالات.

مناقشة مساندة. غالبًا لا يكفي أن تقول للقراء افعل هذا أو افعل ذاك. إنهم يحتاجون إلى معلومات تفسيرية إضافية مثل: كيف ينبغي أن يبدو الشيء قبل الخطوة وبعدها؛ ولماذا ينبغي أن يهتموا بتنفيذ هذه الخطوة؛ وما المبدأ الميكانيكي وراء ما يقومون به؛ وحتى تفسير أدق للخطوة—أي مناقشة الأفعال المحددة التي تتكون منها الخطوة.

لكن مشكلة المناقشة المساندة هي أنها قد تُخفي الخطوة الفعلية. أنت تريد أن تبرز الخطوة نفسها—الأفعال المحددة التي على القارئ تنفيذها—وألا تُدفن في كومة من الكلمات. وهناك طريقتان على الأقل لتجنب هذه المشكلة: يمكنك فصل الأمر/التوجيه عن الشرح المساند في فقرات منفصلة؛ أو يمكنك جعل نصّ التوجيه غامقًا.

Use of bold and color in list labels
تغميق خطوات المستخدم الفعلية في التعليمات. يساعد النص الغامق على تمييز الفعل/الإجراء الفعلي عن المعلومات المساندة.

Opening quotation mark تجنّب الأسلوب البرقي—أي حذف أدوات التعريف/التنكير «المفهومة ضمنًا» (the, a, an). صحيح أن الروبوتات تكتب بهذه الطريقة، لكننا لسنا مضطرين لذلك!) Closing quotation mark

أسلوب الكتابة. قد يبدو أسلوب كتابة التعليمات، جملةً بجملة، متناقضًا مع ما تعلّمته في دروس الكتابة السابقة. لكن لاحِظ كيف تُكتب تعليمات «العالم الحقيقي»—فهي تستخدم كثيرًا أسلوب الأمر (التوجيه المباشر) وتستخدم كثيرًا ضمير «أنت». وهذا مناسب تمامًا. فأنت تريد جذب انتباه القارئ بالكامل. لذلك تبدو جمل التعليمات مثل: «الآن اضغط زر الإيقاف المؤقت (Pause) على اللوحة الأمامية لإيقاف العرض مؤقتًا» و«يجب أن تكون حذرًا من أن... »

تتضمن إحدى المشكلات الخاصة استخدام المبني للمجهول في التعليمات. ولسبب غريب تبدو بعض التعليمات هكذا: «يجب ضغط زر الإيقاف المؤقت (Pause) لإيقاف العرض مؤقتًا». فليس فقط أننا نقلق على الصحة النفسية لزر الإيقاف المؤقت، بل نتساءل أيضًا: من المفترض أن يضغط الزر؟ (هل تخاطبني أنا؟). أو خذ هذا المثال: «ثم يُضبط زر المؤقّت (Timer) على 3:00». مرة أخرى، بصفتك الشخص الذي يتبع هذه التعليمات، قد لا تنتبه لهذا؛ وقد تظن أنه مجرد وصف لحالة قائمة، أو تتساءل: «هل يخاطبونني؟». ومثل ذلك تقريبًا استخدام الغائب: «يجب على المستخدم بعد ذلك الضغط على زر الإيقاف المؤقت». فتعود نفس اللقطة: تنظر حولك وتتساءل: «أنا المقصود؟». (لمزيد من التفاصيل، انظر مشكلة المبني للمجهول.)

ومن المشكلات الشائعة الأخرى في أسلوب كتابة التعليمات أن الناس يميلون إلى حذف أدوات التعريف/التنكير: «اضغط زر الإيقاف المؤقت على اللوحة الأمامية لإيقاف عرض المعلومات مؤقتًا» أو «يا ساكن الأرض، رجاءً قدّم عنوان أقرب مطعم بيتزا». لماذا نفعل هذا؟ هل نريد جميعًا سرًا أن نكون روبوتات؟ على أي حال، تأكد من تضمين جميع الأدوات (a, an, the) وغيرها من الكلمات التي نستخدمها عادةً في التعليمات.

الرسومات في التعليمات

ربما أكثر من أي نوع آخر من الكتابة (باستثناء القصص المصورة ربما)، تُعد الرسومات عنصرًا حاسمًا في التعليمات. فأحيانًا لا تستطيع الكلمات وحدها شرح الخطوة. وغالبًا تكون الرسوم التوضيحية ضرورية لقدرة القرّاء على تصور ما ينبغي عليهم فعله.

في مقرر الكتابة التقنية قد يُطلب منك إدراج رسومات توضيحية أو أنواع أخرى من الرسومات—أيًا كان ما يُستخدم عادةً في مثل هذه التعليمات. لكن المشكلة قد تكون أنك لا تملك رسومات مناسبة لتعليماتك المحددة، وأنك لا تشعر بثقة كبيرة في قدراتك الفنية. توجد طرق لتجاوز هذه المشكلات! ألقِ نظرة على الاقتراحات في الرسومات. ستجد هناك ليس فقط اقتراحات لإنشاء الرسومات، بل أيضًا متطلبات تتعلق بتنسيقها.

تنسيق التعليمات

العناوين. في تعليماتك استخدم العناوين استخدامًا جيدًا. عادةً ستحتاج إلى عناوين لأي قسم خلفية قد يتضمنه النص، ولقسم المعدات والمواد، ولعنوان عام لقسم التعليمات الفعلية، وعناوين فرعية للمهام أو المراحل الفردية داخل ذلك القسم. ألقِ نظرة على الأمثلة في بداية هذا الفصل. انظر العناوين لمعرفة المتطلبات الشائعة.

القوائم. وبالمثل، تستخدم التعليمات عادةً القوائم بكثرة، وخاصة القوائم الرأسية المُرقّمة لشرح الخطوات خطوةً بخطوة. القوائم الرأسية البسيطة أو قوائم العمودين مناسبة عادةً لقسم المعدات والمواد. أما القوائم داخل الجملة فتكون جيدة عندما تقدّم لمحة عامة عمّا سيأتي. انظر القوائم لمعرفة المتطلبات الشائعة.

الإشعارات الخاصة. في التعليمات يجب أن تُنبه القرّاء إلى احتمالات قد يتلفون فيها معداتهم، أو يهدرون المواد، أو يتسببون في فشل الإجراء بالكامل، أو يُصيبون أنفسهم أو غيرهم—حتى إصابات خطيرة أو قاتلة. وقد رُفعت دعاوى على شركات بسبب غياب هذه الإشعارات الخاصة، أو بسبب سوء صياغتها، أو بسبب وضعها في غير موضعها. انظر الإشعارات الخاصة لمناقشة كاملة للاستخدام الصحيح لهذه الإشعارات وكذلك تنسيقها ومواضعها داخل التعليمات.

الأرقام والاختصارات والرموز. تستخدم التعليمات أيضًا كثيرًا من الأرقام والاختصارات والرموز. انظر الإرشادات الخاصة بهذه المجالات.

Indentation of notice to the text of list item
Nonidentation of notices outside of lists
إزاحة الإشعارات في التعليمات. في المثال الأول، لاحِظ كيف تُزاح الإشعار إلى موضع نص الخطوة السابقة. وفي المثال الثاني، لاحِظ أن الإشعار الشديد وُضع في البداية قبل أي خطوة.

مطالبات الذكاء الاصطناعي للتعليمات

يمكن استخدام قوائم التحقق، التي غالبًا لا تُقرأ، كمصدر لمطالبات الذكاء الاصطناعي مع بعض التعديل. انسخ ما يلي، والصقه في نظام ذكاء اصطناعي مثل Gemini من Google، وانظر ما الذي قد تكون فاتك ملاحظته.

ملاحظة: يمكن العثور على جميع الإحالات إلى محتوى خطابات التقديم وتنسيقها وأسلوبها أو مكوّناتها في كتاب الكتابة التقنية عبر الإنترنت.

عندما تريد استخدام الذكاء الاصطناعي لتقييم مشروع كتابي، عرّف بنفسك، وأخبر النظام من أنت وماذا تريد. قدّم له مرجعًا يساعده في إجراء التقييم مثل كتاب دراسي عبر الإنترنت. ثم انشر ما تريد من النظام أن يتحقق منه في تقييمه.

عدّل المقدمة لتناسب هويتك.

مطالبات الذكاء الاصطناعي للتعليمات

مرحبًا أيها الذكاء الاصطناعي. أطلب منك تقييم تعليمات كتبها طالب جامعي في الولايات المتحدة (سنة ثانية). فيما يلي ملخص لفصول الكتاب الدراسي حول التعليمات والإشعارات لاستخدامه كأساس لتقييمك. (تم إخفاء المعلومات التعريفية):

  1. هل تتضمن هذه التعليمات عنوانًا موجّهًا للمهمة؟ حتى لو كان العنوان ذكيًا أو مرحًا، هل يوضح موضوعه بشكل كافٍ؟ للتفاصيل، انظر العناوين.
  2. هل تُبين المقدمة موضوع التعليمات وهدفها والجمهور المستهدف بشكل كافٍ؟ وهل تقدم قائمة بالموضوعات الفرعية التي ستُغطى وتوضح النطاق (ما الذي لن يُغطى)؟ للتفاصيل، انظر المقدمات.
  3. هل يبدأ كل قسم من متن هذه التعليمات بعنوان مُعرِّف؟ للتفاصيل، انظر العناوين.
  4. هل هناك حاجة إلى نوعٍ ما من قائمة بالمعدات والمواد؟ وإذا كان الأمر كذلك، فهل تُعرَّف العناصر التي قد تكون غير مألوفة في القائمة بطريقة ما؟ للتفاصيل، انظر المقدمات.
  5. هل تُعرَّف المصطلحات التي قد لا يفهمها الجمهور المستهدف إما عند ورودها أو في مسرد؟ للتفاصيل، انظر التعريفات.
  6. هل تُستخدم الإشعارات في مواضع مناسبة داخل هذه التعليمات؟ وهل تتبع الإشعارات المستخدمة المواصفات المذكورة في فصل الإشعارات؟ وهل تمّت إزاحة الإشعارات (Indentation) بشكل صحيح، خصوصًا إذا كانت تابعة لخطوة مُرقّمة؟ للتفاصيل، انظر الإشعارات.
  7. هل تنقص هذه التعليمات أي خطوات ضرورية أو أي شرح للخطوات يُفترض وجوده؟
  8. هل تُستخدم أشكال/رسومات (رسوم بيانية، توضيحات) في هذه التعليمات؟ وإذا لم تُستخدم، فهل ينبغي استخدامها؟ وبخصوص الرسومات المستخدمة أو المطلوبة: هل تُستخدم صناديق نص وصفية إذا تعذر توفير توضيحات فعلية؟ للتفاصيل، انظر الرسومات.
  9. هل يُستخدم التمييز (غامق، مائل، خطوط بديلة) في هذه التعليمات؟ وهل يُستخدم بشكل متسق؟ وهل توجد مبالغة في التمييز تسبب تشتيتًا للقراء؟ للتفاصيل، انظر التمييز.
  10. هل تم تجنّب النص المكتوب بأحرف كبيرة بالكامل (ALL CAPS) والأسلوب البرقي في هذه التعليمات؟ للتفاصيل، انظر التعليمات وحالات الحروف (Capitalization).
  11. هل يخلو نص هذه التعليمات من أخطاء القواعد، والاستعمال اللغوي، وعلامات الترقيم؟ للتفاصيل، انظر مشكلات شائعة في القواعد والاستعمال والإملاء.
  12. هل يخلو نص هذه التعليمات من الحشو (wordiness) وأخطاء أسلوب الجملة الأخرى؟ للتفاصيل، انظر الحشو ومشكلات أسلوب الجملة الأخرى.
  13. هل يمكن للجمهور المستهدف (كما هو مبيَّن في المقدمة) فهم هذه التعليمات؟ للتفاصيل، انظر تحليل الجمهور، وانظر ترجمة النص التقني.
  14. بالنظر إلى التقييمات أعلاه:
    • ما الجيد في هذه التعليمات؟
    • ما غير الجيد في هذه التعليمات؟
  15. ما الدرجة الرقمية (من 100) التي يمكن منحها لهذه التعليمات باستخدام أسئلة التقييم أعلاه؟

معلومات ذات صلة

كيف يمكنني إنشاء كتيبات/أدلة تعليمات فعّالة

التكلفة الخفية لعبارة «سهل لدرجة أنه لا يحتاج إلى دليل»

هل تسهم أدلة التشغيل في أداء الأعمال؟

أقدّر أفكارك وردود فعلك وملاحظاتك النقدية حول هذا الفصل: ردّكDavid McMurrey.