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

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

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

NotebookLM-generated infographic of this chapter مخطط معلوماتي تم إنشاؤه بواسطة NotebookLM لهذا الفصل

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

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

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

تأكد من رؤية الـ مثال على الوثائق التقنية.

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

رسالة مرافقة

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

Business letter and email versions of transmital message
أمثلة على خطاب إرفاق ورسالة مصاحبة

في مثال خطاب الإرسال، لاحظ تنسيق الرسالة التجارية القياسي. إذا كتبت مستندًا فنيًا داخليًا، فاستخدم صيغة المذكرة بدلاً من ذلك؛ في كلتا الحالتين، المحتوى والتنظيم متماثلان:

الفقرة الأولى. يشير إلى اسم الوثيقة التقنية ويضعه بخط مائل. كما يذكر تاريخ الاتفاق على كتابة الوثيقة التقنية.

الفقرة الوسطى. يركز على غرض الوثيقة التقنية ويقدم لمحة موجزة عن محتوياتها.

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

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

الأغلفة، صفحة العنوان والملصق

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

أغطية

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

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

صفحة العنوان

بأبسط صورة، يكون عنوان المستند التقني عبارة عن نسخة عما على الغلاف الأمامي—ربما مع إضافة بعض التفاصيل.

ألقِ نظرة على صفحة العنوان الملخص والملخص التنفيذي.

التسميات

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

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

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


خطاب مرفق وغلاف الوثيقة التقنية (مع ملصق الغلاف)

الملخص والملخص التنفيذي

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

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


جدول المحتويات (أي يأتي أولاً) ثم الملخص التنفيذي.

جدول المحتويات

بغض النظر عن تنسيق جدول المحتويات (TOC) الذي تستخدمه، فهذه هي المعايير الشائعة: