ملاحظات:
- يركّز هذا الفصل، وكذلك بقية هذا الكتاب في الكتابة التقنية، على مهارات الكتابة التقنية. لا يُضمن أن يكون المحتوى التقني هنا ناجحًا أو دقيقًا أو محدثًا.
- تمت ترجمة هذا الفصل باستخدام OpenAI ChatGPT. يُرجى الإبلاغ عن مشكلات اللغة إلى admin@mcmassociates.io.
- يرجى النقر هنا لمساعدة ديفيد مكمرّي في دفع تكاليف استضافة الموقع: تبرّع بأي مبلغ تستطيع! سيبقى كتاب الكتابة التقنية عبر الإنترنت مجانيًا.
يركّز هذا الفصل على أحد أهم استخدامات الكتابة التقنية على الإطلاق—وهو التعليمات. وكما تعلم، فإن التعليمات هي تلك الشروحات المتتابعة خطوة بخطوة لكيفية إنجاز شيء ما: كيفية البناء، أو التشغيل، أو الإصلاح، أو الصيانة.
تأكّد من الاطلاع على الأمثلة.
هل تكتب مجموعة تعليمات للعمل أو لمقرر في الكتابة التقنية؟ جرّب هذا دليل تخطيط التعليمات.
كتابة التعليمات
أحد أكثر الاستخدامات شيوعًا وأهمية للكتابة التقنية هو التعليمات—تلك الشروحات خطوة بخطوة لكيفية إنجاز الأمور: تجميع شيء ما، تشغيله، إصلاحه، أو إجراء صيانة روتينية له. ولكن، وعلى الرغم من أن هذا النوع من الكتابة يبدو سهلًا وبديهيًا، فإن التعليمات تُعد من أسوأ أنواع الوثائق كتابةً. ومثلي، لا بد أنك مررت بتجارب محبطة عديدة مع تعليمات سيئة الصياغة. ما يقدّمه هذا الفصل ليس دليلًا مضمونًا وخاليًا من الأخطاء لكتابة التعليمات، لكنه يبيّن لك ما يعتبره المحترفون أفضل الأساليب.
وفي النهاية، تتطلّب كتابة التعليمات الجيدة ما يلي:
- كتابة واضحة وبسيطة
- فهمًا شاملًا للإجراء بجميع تفاصيله التقنية
- قدرتك على وضع نفسك مكان القارئ، أي الشخص الذي يحاول استخدام تعليماتك
- قدرتك على تصوّر الإجراء بتفصيل كبير ونقل هذا الوعي إلى الورق
- وأخيرًا، استعدادك لبذل الجهد الإضافي واختبار تعليماتك على النوع نفسه من الأشخاص الذين كتبت لهم
بحلول هذه المرحلة، من المحتمل أنك درست العناوين، والقوائم، والإشعارات الخاصة—وقد يبدو لك أن كتابة مجموعة تعليمات باستخدام هذه الأدوات أمر بديهي. فقط قسّم النقاش إلى قوائم رأسية مرقّمة، وأضف بعض الإشعارات الخاصة في المواضع الواضحة، وتنتهي المهمة! حسنًا، ليس تمامًا، لكنه بداية ممتازة. يستكشف هذا الفصل بعض خصائص التعليمات التي قد تجعلها أكثر تعقيدًا، ويمكنك بدورك استخدام هذه الاعتبارات لتخطيط تعليماتك الخاصة.
مخطط معلوماتي أُنشئ بواسطة NotebookLM لهذا الفصل
بعض المقدمات
في بداية مشروع كتابة التعليمات، من المهم تحديد البنية أو الخصائص للإجراء المحدد الذي ستكتب عنه.
الجمهور والسياق. في وقت مبكر من العملية، حدّد جمهور تعليماتك وسياقها. تذكّر أن تحديد الجمهور يعني تحديد مستوى إلمامه بالموضوع، إضافة إلى تفاصيل أخرى مشابهة. راجع مناقشة الجماهير والخطوات المستخدمة في تعريفها.
والأهم من ذلك، إذا كنت في مقرر للكتابة، فستحتاج إلى كتابة وصف لجمهورك وإرفاقه بتعليماتك. يتيح ذلك لمعلّمك تقييم تعليماتك من حيث ملاءمتها للجمهور المستهدف. وتذكّر أيضًا أنه في مقررات الكتابة التقنية يُفضَّل الكتابة لجماهير غير متخصصة—وهو تحدٍّ أكبر لك ككاتب.
عدد المهام. كم عدد المهام الموجودة في الإجراء الذي تكتب عنه؟ لنستخدم مصطلح الإجراء للإشارة إلى مجموعة الأنشطة الكاملة التي تهدف تعليماتك إلى مناقشتها. أمّا المهمة فهي مجموعة شبه مستقلة من الأفعال ضمن الإجراء؛ على سبيل المثال، ضبط الساعة في فرن الميكروويف يُعد مهمة واحدة ضمن الإجراء العام لتشغيل فرن الميكروويف.
إجراء بسيط مثل تغيير زيت السيارة يحتوي على مهمة واحدة فقط؛ فلا توجد مجموعات شبه مستقلة من الأنشطة. أمّا إجراء أكثر تعقيدًا مثل استخدام فرن الميكروويف فيحتوي على العديد من المهام شبه المستقلة: ضبط الساعة، ضبط مستوى الطاقة، استخدام المؤقّت، تنظيف الميكروويف وصيانته، وغيرها. (إن تعليمات استخدام الكاميرا منظّمة حسب المهام.)
تحتوي بعض التعليمات على مهمة واحدة فقط، ولكن تتضمن العديد من الخطوات داخل تلك المهمة الواحدة. على سبيل المثال، تخيّل مجموعة تعليمات لتجميع أرجوحة للأطفال. في تجربتي الشخصية، كان هناك أكثر من 130 خطوة! قد يكون ذلك أمرًا مربكًا. ومن الأساليب الجيدة تجميع الخطوات المتشابهة والمرتبطة في مراحل، ثم إعادة ترقيم الخطوات مع كل مرحلة جديدة. وتُعد المرحلة مجموعة من الخطوات المتشابهة ضمن إجراء ذي مهمة واحدة. في مثال الأرجوحة، يكون إعداد الإطار مرحلة؛ وتثبيته في الأرض مرحلة أخرى؛ وتجميع المقعد مرحلة ثالثة.
استخدم التوجّه القائم على المهام. ركّز على المهام التي يريد قرّاؤك تنفيذها؛ واستخدم صياغات «كيفية» أو صياغات تنتهي بـ –ing في العناوين.
أفضل نهج لمناقشة الخطوات خطوة بخطوة. من الاعتبارات الأخرى—والتي قد لا تتمكن من تحديدها مبكرًا—كيفية تركيز تعليماتك. في معظم التعليمات، يمكنك التركيز على المهام، أو يمكنك التركيز على الأدوات (أو ميزات الأدوات).
في نهج المهام (ويُعرف أيضًا بالتوجّه القائم على المهام) لتعليمات استخدام خدمة الرد على الهاتف، ستكون لديك الأقسام التالية:
- تسجيل التحية
- تشغيل الرسائل
- حفظ الرسائل
- إعادة توجيه الرسائل
- حذف الرسائل، وهكذا
هذه مهام—وهي الأشياء النموذجية التي نرغب في القيام بها باستخدام الجهاز. لمزيد من النقاش، راجع الفصل الخاص بـ تحليل المهام.
ومن ناحية أخرى، في نهج الأدوات لتعليمات استخدام آلة تصوير المستندات، ستكون هناك أقسام غير محتملة مثل:
- زر النسخ
- زر الإلغاء
- زر التكبير/التصغير
- زر التجميع/التدبيس
- زر حجم النسخ، وهكذا
إذا صمّمت مجموعة تعليمات وفق هذا النهج، فستكتب خطوات لاستخدام كل زر أو ميزة في آلة التصوير. من الصعب جعل التعليمات التي تستخدم نهج الأدوات فعّالة. ففي بعض الأحيان لا يتطابق اسم الزر تمامًا مع المهمة المرتبطة به؛ وأحيانًا تحتاج إلى استخدام أكثر من زر واحد لإنجاز المهمة. ومع ذلك، قد تكون هناك حالات يُفضَّل فيها نهج الأدوات/الميزات.
تجميع المهام. قد لا يكون سرد المهام كافيًا. فقد يكون عدد المهام كبيرًا لدرجة تستلزم تجميعها بحيث يتمكن القرّاء من العثور على المهام الفردية بسهولة أكبر. على سبيل المثال، فيما يلي تجميعات شائعة للمهام في التعليمات:
- مهام التفريغ والإعداد
- مهام التثبيت والتخصيص
- مهام التشغيل الأساسية
- مهام الصيانة الروتينية
- مهام استكشاف الأخطاء وإصلاحها، وهكذا
الأقسام الشائعة في التعليمات
فيما يلي مراجعة للأقسام التي ستجدها عادةً في التعليمات. لا تفترض أن كل واحد منها يجب أن يكون موجودًا في التعليمات التي تكتبها فعليًا، ولا أنها يجب أن تكون بالترتيب المعروض هنا، ولا أن هذه هي الأقسام الوحيدة الممكنة في مجموعة تعليمات.
أثناء قراءتك للأقسام الشائعة في التعليمات، اطّلع على نماذج التعليمات.
(guitar)
instrux_fig1.png
عرض تخطيطي للتعليمات. تذكّر أن هذا نموذج نموذجي أو شائع لمحتويات التعليمات وتنظيمها—وهناك العديد من النماذج الأخرى الممكنة.
المقدمة. خطّط لمقدمة تعليماتك بعناية. تأكّد من أنها تقوم بأي مما يلي (ليس بالضرورة بهذا الترتيب) مما ينطبق على تعليماتك الخاصة:
- تحديد المهام أو الإجراء المحدد الذي سيتم شرحه، وكذلك نطاق التغطية (ما لن يتم تغطيته).
- تحديد ما يحتاجه الجمهور من حيث المعرفة والخلفية لفهم التعليمات.
- تقديم فكرة عامة عن الإجراء وما يحققه.
- تحديد الظروف التي ينبغي (أو لا ينبغي) استخدام هذه التعليمات فيها.
- تقديم نظرة عامة على محتويات التعليمات.
راجع القسم الخاص بـ المقدمات لمزيد من النقاش.
إشعارات التحذير والتنبيه والخطر العامة. غالبًا ما يجب على التعليمات تنبيه القرّاء إلى احتمال إتلاف معداتهم، أو إفساد الإجراء، أو تعريض أنفسهم للأذى. كما يجب على التعليمات التأكيد على النقاط الأساسية أو الاستثناءات. في هذه الحالات، تستخدم الإشعارات الخاصة—مثل الملاحظة، والتحذير، والتنبيه، والخطر. لاحظ كيفية استخدام هذه الإشعارات الخاصة في نماذج التعليمات المذكورة أعلاه.
الخلفية التقنية أو النظرية. في بداية أنواع معينة من التعليمات (بعد المقدمة بالطبع)، قد تحتاج إلى مناقشة خلفية متعلقة بالإجراء. في بعض التعليمات، تكون هذه الخلفية ضرورية—وإلا فلن تكون خطوات الإجراء منطقية. على سبيل المثال، ربما كانت لديك تجربة مع تلك التطبيقات البرمجية التي تتيح لك تحديد الألوان عن طريق تحريك أشرطة تمرير الأحمر والأخضر والأزرق. لفهم ما تفعله حقًا، تحتاج إلى بعض الخلفية حول الألوان. وبالمثل، يمكنك أن تتخيّل أنه في بعض التعليمات المتعلقة باستخدام الكاميرات، قد تكون هناك حاجة إلى بعض النظرية أيضًا.
المعدات واللوازم. لاحظ أن معظم التعليمات تتضمن قائمة بالأشياء التي تحتاج إلى جمعها قبل البدء في الإجراء. يشمل ذلك المعدات، أي الأدوات التي تستخدمها في الإجراء (مثل أوعية الخلط، والملاعق، وقوالب الخبز، والمطارق، والمثاقب، والمناشير)، واللوازم، أي الأشياء التي تُستهلك أثناء الإجراء (مثل الخشب، والطلاء، والزيت، والدقيق، والمسامير). في التعليمات، تُدرج هذه العناصر عادةً إما في قائمة رأسية بسيطة أو في قائمة من عمودين. استخدم القائمة ذات العمودين إذا كنت بحاجة إلى إضافة بعض المواصفات لبعض العناصر أو كلها—مثل أسماء العلامات التجارية، والأحجام، والكميات، والأنواع، وأرقام الطرازات، وما إلى ذلك.
مناقشة الخطوات. عند الوصول إلى كتابة الخطوات الفعلية، هناك عدة أمور يجب وضعها في الاعتبار: (1) بنية وتنسيق تلك الخطوات، (2) المعلومات التكميلية التي قد تكون مطلوبة، و(3) وجهة النظر وأسلوب الكتابة العام.
البنية والتنسيق. عادةً ما نتخيّل مجموعة التعليمات على أنها مُنسّقة على شكل قوائم رأسية مرقّمة—وهو ما يحدث بالفعل في معظم الحالات. عادةً ما تُنسّق تعليماتك خطوة بخطوة بهذه الطريقة. ومع ذلك، توجد بعض الاختلافات وبعض الاعتبارات الأخرى:
- الخطوات ذات الترتيب الثابت هي خطوات يجب تنفيذها بالترتيب المعروض. على سبيل المثال، إذا كنت تغيّر زيت سيارة، فإن تصريف الزيت خطوة يجب أن تسبق إضافة الزيت الجديد. تُعرض هذه الخطوات في قوائم مرقّمة (عادةً قوائم رأسية مرقّمة).
- الخطوات ذات الترتيب المتغيّر هي خطوات يمكن تنفيذها بأي ترتيب تقريبًا. ومن الأمثلة الجيدة على ذلك أدلة استكشاف الأخطاء وإصلاحها التي تطلب منك التحقق من هذا ثم ذاك أثناء محاولتك إصلاح شيء ما. يمكن تنفيذ هذه الخطوات بأي ترتيب تقريبًا. في هذا النوع، تكون القائمة ذات التعداد النقطي هي التنسيق المناسب.
- الخطوات البديلة هي تلك التي يتم فيها تقديم طريقتين أو أكثر لإنجاز الشيء نفسه. تُستخدم الخطوات البديلة أيضًا عندما قد توجد ظروف مختلفة. استخدم القوائم النقطية مع هذا النوع، مع إدراج «أو» بين البدائل، أو مع تمهيد يشير إلى أن بدائل ستُعرض.
- الخطوات المتداخلة. في بعض الحالات، قد تكون الخطوات الفردية ضمن إجراء ما معقّدة بحد ذاتها وتحتاج إلى تقسيمها إلى خطوات فرعية. في هذه الحالة، تُزاد المسافة البادئة، وتُسلسل الخطوات الفرعية بالحروف أ، ب، ج، وهكذا.
- التعليمات «بلا خطوات». وأخيرًا، توجد تعليمات لا يمكنها فعليًا استخدام القوائم الرأسية المرقّمة ولا تقدّم سوى القليل—إن وُجد—من التوجيه التعليمي المباشر للقارئ. فبعض المواقف تكون عامة جدًا أو متغيّرة جدًا بحيث لا يمكن تحديد خطوات لها.
انظر الفصل الخاص بـ القوائم لمعرفة الأسلوب والتنسيق المناسبين لهذه الاحتمالات.
مناقشة تكميلية. في كثير من الأحيان، لا يكفي مجرد إخبار القرّاء بأن يفعلوا هذا أو ذاك. فهم بحاجة إلى معلومات تفسيرية إضافية، مثل: كيف يجب أن يبدو الشيء قبل تنفيذ الخطوة وبعدها؛ ولماذا ينبغي عليهم الاهتمام بتنفيذ هذه الخطوة؛ وما هو المبدأ الميكانيكي الكامن وراء ما يقومون به؛ بل وحتى شرح أكثر تفصيلاً على مستوى أدق للخطوة نفسها — أي مناقشة الإجراءات المحددة التي تتكوّن منها الخطوة.
غير أن المشكلة في المناقشة التكميلية هي أنها قد تُخفي الخطوة الفعلية. فأنت تريد أن تبرز الخطوة نفسها — أي الإجراءات المحددة التي يُطلب من القارئ تنفيذها — لا أن تُدفن في كومة من الكلمات. هناك على الأقل تقنيتان لتجنب هذه المشكلة: يمكنك فصل التعليمات عن الشرح في فقرات مستقلة؛ أو يمكنك تمييز التعليمات بالخط العريض.
تمييز خطوات المستخدم الفعلية في التعليمات. يساعد النص الغامق على التمييز بين الإجراء الفعلي والمعلومات التكميلية.
تجنّب الأسلوب البرقي — أي حذف أدوات التعريف المفهومة ضمنيًا (the، a، an). صحيح أن الروبوتات تكتب بهذه الطريقة، لكننا لسنا مضطرين إلى ذلك.
أسلوب الكتابة. قد يبدو أسلوب كتابة التعليمات، جملةً بعد جملة، متناقضًا مع ما علّمته لك دروس الكتابة السابقة. ولكن لاحظ كيف تُكتب التعليمات في "العالم الحقيقي" — فهي تستخدم كثيرًا أسلوب الأمر (أو الخطاب المباشر)؛ وتستخدم كثيرًا كلمة "أنت". وهذا أمر مناسب تمامًا. فأنت تريد جذب انتباه القارئ بالكامل. ولهذا السبب، تبدو جمل التعليمات مثل: "الآن، اضغط زر الإيقاف المؤقت الموجود على اللوحة الأمامية لإيقاف العرض مؤقتًا" و"يجب أن تكون حذرًا حتى لا ...".
تتمثل إحدى المشكلات الشائعة في استخدام المبني للمجهول في التعليمات. ولسبب غريب، تبدو بعض التعليمات على النحو التالي: "يجب الضغط على زر الإيقاف المؤقت لإيقاف العرض مؤقتًا." لسنا قلقين فقط على الصحة النفسية لزر الإيقاف المؤقت، بل نتساءل أيضًا: من المفترض أن يضغط عليه؟ أو خذ هذا المثال: "يتم بعد ذلك ضبط زر المؤقّت على 3:00." مرة أخرى، قد يظن القارئ أن هذا مجرد وصف لحالة قائمة، أو قد يتساءل: "هل يتحدثون إليّ؟" ومن السيئ أيضًا استخدام الغائب: "يجب على المستخدم بعد ذلك الضغط على زر الإيقاف المؤقت." فتجد نفسك تنظر حولك وتتساءل: "هل يقصدونني أنا؟" (للمزيد من التفاصيل، انظر مشكلة المبني للمجهول.)
ومن المشكلات الشائعة الأخرى في أسلوب كتابة التعليمات رغبة الكُتّاب في حذف أدوات التعريف: "اضغط زر الإيقاف المؤقت على اللوحة الأمامية لإيقاف العرض مؤقتًا" أو "يا كائن الأرض، الرجاء تزويدنا بعنوان أقرب مطعم بيتزا." لماذا نفعل هذا؟ هل نرغب جميعًا سرًا في أن نكون روبوتات؟ على أي حال، تأكد من تضمين جميع أدوات التعريف (a، an، the) وغيرها من الكلمات التي نستخدمها عادة في التعليمات.
الرسومات في التعليمات
ربما أكثر من أي نوع آخر من الكتابة (باستثناء القصص المصوّرة)، تُعد الرسومات ضرورية في التعليمات. ففي بعض الأحيان، تعجز الكلمات وحدها عن شرح الخطوة. وغالبًا ما تكون الرسوم التوضيحية أساسية لقدرة القرّاء على تصوّر ما يُطلب منهم القيام به.
في مقررات الكتابة التقنية، قد يُطلب منك تضمين رسوم توضيحية أو أنواع أخرى من الرسومات — أي ما يُستخدم عادة في مثل هذه التعليمات. والمشكلة، بالطبع، أنك قد لا تملك رسومات مناسبة، أو أنك لا تثق كثيرًا في قدراتك الفنية. لكن هناك طرقًا للتغلب على هذه المشكلات! ألقِ نظرة على الاقتراحات الواردة في فصل الرسومات. ستجد هناك اقتراحات لإنشاء الرسومات، إضافةً إلى متطلبات تنسيقها.
التنسيق في التعليمات
العناوين. احرص في تعليماتك على الاستخدام الجيد للعناوين. فعادةً، ستحتاج إلى عناوين لقسم الخلفية، وقسم المعدات واللوازم، وعنوان عام لقسم التعليمات نفسها، وعناوين فرعية للمهام الفردية أو المراحل المختلفة. انظر إلى الأمثلة في بداية هذا الفصل. راجع فصل العناوين للاطلاع على المتطلبات الشائعة.
القوائم. وبالمثل، تعتمد التعليمات اعتمادًا كبيرًا على القوائم، لا سيما القوائم الرأسية المرقّمة لشرح الخطوات خطوةً بخطوة. كما تُعد القوائم البسيطة أو القوائم ذات العمودين مناسبة لقسم المعدات واللوازم. وتفيد القوائم داخل الجملة عند تقديم نظرة عامة. راجع فصل القوائم للاطلاع على المتطلبات الشائعة.
الإشعارات الخاصة. في التعليمات، يجب تنبيه القرّاء إلى الحالات التي قد يتسببون فيها بإتلاف المعدات، أو هدر المواد، أو فشل الإجراء بالكامل، أو إيذاء أنفسهم أو الآخرين — حتى إصابات خطيرة أو مميتة. لقد رُفعت دعاوى قضائية ضد شركات بسبب غياب هذه الإشعارات، أو سوء صياغتها، أو وضعها في أماكن غير مناسبة. راجع فصل الإشعارات الخاصة لمناقشة كاملة حول استخدامها وتنسيقها ومكانها داخل التعليمات.
الأرقام والاختصارات والرموز. تستخدم التعليمات أيضًا الكثير من الأرقام والاختصارات والرموز. راجع الإرشادات الخاصة بهذه الجوانب.
محاذاة الإشعارات في التعليمات. في المثال الأول، لاحظ كيف تُحاذى الإشعارات مع نص الخطوة السابقة. وفي المثال الثاني، لاحظ كيف وُضع الإشعار الشديد في البداية قبل أي خطوات.
مطالبات الذكاء الاصطناعي للتعليمات
يمكن استخدام قوائم التحقق، التي غالبًا ما لا تُقرأ، كمصدر لمطالبات الذكاء الاصطناعي مع بعض التعديل. انسخ ما يلي، والصقه في نظام ذكاء اصطناعي مثل Google Gemini، وانظر ما الذي قد تكون أغفلته.
ملاحظة: يمكن العثور على جميع الإشارات إلى المحتوى والتنسيق وأسلوب خطابات التقديم أو مكوّناتها في كتاب الكتابة التقنية عبر الإنترنت.
عند استخدام الذكاء الاصطناعي لتقييم مشروع كتابي، قدّم نفسك أولًا، وأخبر الذكاء الاصطناعي من أنت وما الذي تريده. أعطه نقطة مرجعية لإجراء التقييم، مثل كتاب إلكتروني. ثم انشر النص الذي تريد تقييمه.
عدّل المقدمة لتناسب هويتك.