تعلّم الكتابة التقنية بالإنجليزية: توثيق الوثائق ووضوح التعليمات مع جمل وأمثلة
ما الذي يجعل الكتابة "تقنية"؟
الكتابة التقنية هي فن نقل المعلومات الدقيقة إلى مستخدم حقيقي بطريقة يستطيع تطبيقها. قد تبدو مجرد "كتابة تعليمات"، لكنها في الحقيقة مهنة تقوم على قرارات دقيقة: لمن نكتب؟ ماذا يحتاج القارئ أن يعرف؟ وكيف نمنع حدوث أي سوء فهم؟
لا يقتصر هذا المجال على (التوثيق) البرمجي؛ فهو يشمل أدلة الاستخدام ، وتوثيق واجهات البرمجة ، وتقارير الفحص الهندسية، وحتى رسائل الخطأ التي تظهر على شاشتك. الفرق الجوهري بين الكتابة التقنية والكتابة الأدبية أن الأولى تُقيَّم بمعيار واحد: هل فهمها القارئ من أول قراءة؟
في هذا الدرس سنتعلم كيف نحوّل المعلومات المعقدة إلى تعليمات واضحة ، وكيف نتعامل مع المصطلحات المتخصصة ، ولماذا يعد الوضوح قيمة أعلى من الأسلوب الزخرفي، وكيف نكتب إجراءات يستطيع أي مستخدم تنفيذها بنجاح.
أولاً: ابدأ بفهم الجمهور المستهدف (Audience)
قبل أن تكتب أي كلمة، اسأل نفسك: من سيقرأ هذه الوثيقة؟ الفرق بين المبتدئ والخبير يغيّر كل شيء: المبتدئ يحتاج إلى سياق وشرح، والخبير يحتاج إلى سرعة واختصارات.
| English | العربية | مثال في جملة |
|---|---|---|
| الجمهور المقصود | Identify your before you write a single word. | |
| شرط مسبق | The guide lists the for installing the software. | |
| مستوى المهارة | Adjust the level of detail to the reader's . | |
| المستخدم النهائي | The should never need to open the system files. | |
| خبير / مختص | Write for the in the appendix and for beginners in the main guide. | |
| مبتدئ | A will follow each step slowly and literally. |
الخطأ الأكثر شيوعاً في الكتابة التقنية هو الكتابة للنفس لا للقارئ. اسأل نفسك قبل كل جملة: هل يعرف القارئ هذا المصطلح؟ هل يحتاج إلى هذه المعلومة الآن أم في فصل لاحق؟ التمييز بين novice وexpert يحدد درجة التفصيل والمصطلحات المناسبة لكل وثيقة.
ثانياً: الوضوح مقابل الغموض (Clarity vs Ambiguity)
الوضوح هو الاختيار الدقيق لكل كلمة بحيث لا تحتمل الجملة أكثر من معنى واحد. أما الغموض فينشأ عندما تترك الجملة مجالاً لتأويلات متعددة، وهذا هو أخطر أعداء الدليل التقني.
الجملة الغامضة: Please handle the file appropriately.
الجملة الواضحة: Save the file to the project folder and close the editor before restarting.
الجملة الأولى تحتمل عشرات التأويلات: ما المقصود بـ "appropriately"؟ وأين أحفظ الملف؟ أما الثانية فتحدد الفعل والمكان والترتيب، وهذا هو جوهر الوضوح في الكتابة التقنية.
الترجمة والشرح:
استخدم الفعل المباشر في الأمر (انقر، أدخل، اضغط) بدل البناء للمجهول مثل "يتم النقر". انقر على زر الحفظ، أدخل كلمة المرور ثم اضغط Enter. البناء للمجهول مثل "The files are copied" يجعل القارئ يتساءل عمن يقوم بالفعل، بينما "The installer copies the files" تحدد الفاعل وتجعل التعليمات قابلة للتنفيذ مباشرة.
ثالثاً: المصطلحات المتخصصة (Jargon)
المصطلح التقني الصحيح أداة ثمينة، لكن إغراق النص به دون تعريف يطرد القارئ المبتدئ. الحل هو الموازنة: استخدم المصطلح الدقيق وعرفه عند أول ظهور له.
| English | العربية | مثال في جملة |
|---|---|---|
| المصطلحات المتخصصة | Avoid unnecessary when writing for the general public. | |
| المصطلحات | Keep the consistent throughout the manual. | |
| اللغة الإنجليزية المبسطة | The policy was rewritten in . | |
| دقيق | Use names for buttons and menu items. | |
| موجز | Keep each step but complete. |
— لا تحذف المصطلح التقني الصحيح خوفاً من صعوبته؛ المصطلح الدقيق أفضل من وصف مبتذل، لكن عرّفه عند أول استخدام.
— في المقابل، إغراق النص بالمصطلحات المتخصصة بلا ضرورة يطرد القارئ المبتدئ. قارن: "Utilize the aforementioned functionality" مقابل "Use this feature".
— انتبه إلى الأسماء المجردة المبالغ فيها مثل "facilitate" و"optimize" و"leverage"؛ استخدمها فقط حيث تضيف معنى حقيقياً ولا تُستخدم كزخرفة.
رابعاً: بنية التعليمات والإجراءات (Instructions and Procedures)
الإجراء الناجح لا يُترك للصدفة؛ فهو يتبع بنية ثابتة تمنع المستخدم من التساؤل "هل نجحت أم لا؟".
| English | العربية | مثال في جملة |
|---|---|---|
| إجراء | Follow this to configure the network. | |
| خطوة بخطوة | Present the installation as a list. | |
| سير العمل | The diagram shows the whole of the process. | |
| استكشاف الأخطاء | Check the section when an error appears. | |
| رسالة الخطأ | Quote the exact in your report. | |
| قابلية الاستخدام | Testing improves the of the manual. |
الصيغة الذهبية لأي إجراء: (شرط مسبق) + (خطوات مرقمة) + (نتيجة متوقعة). مثال: قبل أن تبدأ، تأكد أن لديك صلاحيات المدير. الخطوة الأولى: افتح التطبيق. النتيجة: تظهر شاشة الترحيب. هذه البنية تمنع المستخدم من التساؤل "هل نجحت أم لا؟".
خامساً: قوة الإيجاز (Conciseness)
الإيجاز لا يعني التضحية بالمعنى؛ بل يعني إزالة كل كلمة لا تخدم الغرض. في الكتابة التقنية، كل جملة زائدة تُعد تكلفة على وقت القارئ، وقد تخفي خلفها معلومة ضرورية.
الترجمة والشرح:
الجملة الأولى مليئة بالحشو ("In order to" و"it is necessary for the user to") الذي لا يضيف معنى جديداً. النسخة الثانية تنقل الفكرة نفسها في نصف الطول تقريباً: لتغيير الإعدادات، أعد تشغيل الجهاز. القاعدة: احذف كل ما يمكن حذفه دون أن يفقد النص معنى، واترك تعليمات واضحة وقابلة للتنفيذ.
"Short words are best, and the old words when short are the best of all." — Winston Churchill
الإيجاز لا يعني التضحية بالمعنى؛ بل يعني إزالة كل كلمة لا تخدم الغرض. في الكتابة التقنية، كل جملة زائدة تُعد تكلفة على وقت القارئ، وقد تخفي خلفها معلومة ضرورية.
مواقف يومية في الكتابة التقنية
مواقف يومية
طبّق ما تعلمته في مواقف حياتية واقعية
- "Could you check the steps for clarity?" (هل يمكنك مراجعة الخطوات من حيث الوضوح؟)
- "This sentence is ambiguous; please rephrase it." (هذه الجملة غامضة، أعد صياغتها من فضلك)
- "Add a note for readers who use an older version." (أضف ملاحظة للقراء الذين يستخدمون إصداراً أقدم)
- "Please flag any step you had to read twice." (ضع علامة على أي خطوة اضطررت لقراءتها مرتين)
- "An unexpected error occurred. Please try again." (حدث خطأ غير متوقع، حاول مرة أخرى)
- "The file could not be saved because the disk is full." (تعذر حفظ الملف لأن القرص ممتلئ)
- "Contact support and quote error code 2031." (اتصل بالدعم واذكر رمز الخطأ ٢٠٣١)
- "Your changes have been saved successfully." (تم حفظ تغييراتك بنجاح)
- "First, install the latest update before proceeding." (أولاً، ثبّت آخر تحديث قبل المتابعة)
- "Restart the router and wait for the lights to stabilize." (أعد تشغيل الموجه وانتظر حتى تستقر الأضواء)
- "If the problem persists, perform a factory reset." (إذا استمرت المشكلة، نفّذ إعادة ضبط المصنع)
- "Keep the device connected throughout the process." (أبقِ الجهاز متصلاً طوال العملية)
- "We need to agree on a single style guide." (علينا الاتفاق على دليل أسلوب واحد)
- "Let us standardize the terminology before writing." (لنوحّد المصطلحات قبل الكتابة)
- "The manual should target both beginners and experts." (يجب أن يستهدف الدليل المبتدئين والخبراء معاً)
- "Who will be responsible for the final revision?" (من سيتولى المراجعة النهائية؟)
حوار: مراجعة وثيقة تقنية
I drafted the installation guide, but it is still too long.
أعددت مسودة دليل التثبيت، لكنه ما زال طويلاً جداً.
Cut every sentence that does not tell the reader what to do.
احذف كل جملة لا تخبر القارئ بما يجب فعله.
Some reviewers asked for more background about the system.
طلب بعض المراجعين مزيداً من الخلفية عن النظام.
Move the background into an appendix and keep the steps short.
انقل الخلفية إلى ملحق وأبقِ الخطوات قصيرة.
What about the technical terms? Should I explain each one?
ماذا عن المصطلحات التقنية؟ هل أشرح كل واحد منها؟
Define a term only at its first use, and keep a glossary.
عرّف المصطلح عند أول استخدام فقط، واحتفظ بمسرد في النهاية.
The error messages section is empty. Can you add examples?
قسم رسائل الخطأ فارغ، هل يمكنك إضافة أمثلة له؟
I will collect the most common ones from the support tickets.
سأجمع أكثرها شيوعاً من تذاكر الدعم.
Send me the final version before the release date, please.
أرسل لي النسخة النهائية قبل موعد الإصدار من فضلك.
You will have it by Friday, after the final proofread.
ستصلك يوم الجمعة بعد إجراء التدقيق النهائي.
تمرين سريع للختام
حاول إعادة كتابة هذه الجملة الغامضة بأسلوب تقني واضح:
"The application may experience some issues if the user does not have enough space."
مقترح واضح: "Check that you have at least 2 GB of free space before you install the application."
اختبر نفسك
0/8 تمت الإجابة
ما هو الهدف الأول في الكتابة التقنية؟
هل انتهيت من الدرس؟
عند الانتهاء اضغط على الزر لتسجيل تقدمك