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

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

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

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

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

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

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

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

رسالة إرسال

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

Business letter and email versions of transmital message
أمثلة على رسالة الإرسال ورسالة الإرسال.

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

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

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

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

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

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

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

أغطية

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

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

صفحة العنوان

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

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

تسميات

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

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

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


رسالة الإرسال وغلاف الوثيقة الفنية (مع ملصق الغلاف).

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

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

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


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

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

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