< كتيبات
ملاحظة:
  • يركّز هذا الفصل، وكذلك بقية كتاب الكتابة التقنية، على مهارات الكتابة التقنية. لا يُضمن أن يكون المحتوى التقني هنا ناجحًا أو دقيقًا أو محدّثًا.
  • تمت ترجمة هذا الفصل باستخدام OpenAI ChatGPT. يرجى الإبلاغ عن أي مشكلات لغوية إلى admin@mcmassociates.io.
  • سيتم ترجمة النص الموجود في الصور على هذه الصفحة في أقرب وقت ممكن.
  • انقر هنا لمساعدة David McMurrey في دفع تكاليف استضافة الموقع: تبرّع بأي مبلغ! سيبقى Online Technical Writing مجانيًا.

الرجاء النقر هنا للمساعدة ديفيد ماكموراي ادفع ثمن استضافة الويب: تبرع بأي مبلغ تستطيع!
ستظل الكتابة التقنية عبر الإنترنت مجانية.

إيه دليل، كما نعرّفه هنا، هو مزيج مما يلي:

  • مفهوم معلومات
  • تعليمات معلومات
  • معلومات مرجعية

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

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

NotebookLM-generated infographic of this chapter
إنفوجرافيك أنشأه NotebookLM لهذا الفصل

أساسيات الدليل

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

اعتبر مثالا آخر: أوامر نظام ملفات لينكس البسيطة—ls, cd, cp, mv, pwd. لاستخدام هذه الأوامر، تحتاج إلى فهم ما هي الملفات والدلائل، وربما ما هو نظام التشغيل وكذلك أحرف البدل. أنت حقًا لا تستطيع فهم كيفية استخدام هذه الأوامر—اتباع التعليمات باستخدامها—ما لم تفهم هذه المفاهيم الأساسية.

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

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

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

تنسيق الدليل وأسلوب الكتابة

في دورة للكتابة التقنية تستخدم هذا الكتاب، قد يُتوقع منك اتباع الإرشادات المحددة بشأن استخدام العناوين والقوائم والإشعارات والرسوم والجداول والتوثيق والمقدمات:

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

نموذج أولي للدليل

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

نموذج أولي لجدول المحتويات

أمثلة من الدليل

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

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

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

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

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

    قريبًا!


أقدّر أفكارك وردود فعلك ونقدك بخصوص هذا الفصل: ردكديفيد ماكموري.