معايير كتابة الوثائق التقنية
كما هو معروف، يمكن أن يجعل التنسيق الموحد والقواعد النحوية الصحيحة للنص تسهيل قراءته وتقليل تكلفة التواصل.
هيكل المقال
عند كتابة المقالات التقنية، يمكن الاستعانة بالهيكل التالي:
# عنوان المقال
جملتان أو ثلاث تعرض محتوى المقال.
## النتيجة
يرجى تقديم نبذة عن استخدام العرض التوضيحي وعرض النتيجة.
## المبدأ
يرجى تقديم المبدأ خطوة بخطوة.
## الاستنتاج
عمل استنتاج بسيط.
## المراجع والشكر
- [المرجع 1](رابط المرجع 1)
- [المرجع 2](رابط المرجع 2)
قواعد التنسيق
الفقرات
- عند استخدام لغة Markdown، لا حاجة للمسافة في السطر الأول.
- يجب أن يكون هناك سطر فارغ بين الفقرات.
الحالات التي تحتاج إلى إضافة مسافة
- بين الكلمات الصينية والإنجليزية والأرقام:
خاطئ:
Qt生成器是一个针对C++的跨平台IDE
صحيح:Qt 生成器是一个针对 C++ 的跨平台 IDE - بين الأرقام والوحدات (ولكن لا حاجة للمسافة بين الأرقام والنسبة المئوية):
خاطئ:
其频率为 72MHz，占空比为 50 %。
صحيح:其频率为 72 MHz، 占空比为 50%。 - بين النص العادي والرموز الخاصة (الروابط، النص العريض، النص المائل، إلخ):
هذا النص يستخدم نمط النص العريض يرجى النقر هنا للاشتراك
- بعد علامات الترقيم النصية النصفية:
Hello, world
- بين النص الصيني والشرطة:
Markdown - طريقة كتابة فعالة
أنماط النص
- عند الجمع بين اللغتين الصينية والإنجليزية، يفضل استخدام علامات الترقيم الصينية الكاملة.
- عند الجمع بين اللغتين الصينية والإنجليزية، إذا ظهرت جملة إنجليزية كاملة، يجب استخدام علامات الترقيم الإنجليزية النصفية في هذه الجملة.
- يفضل استخدام النص العريض للروابط الداخلية لزيادة قابلية القراءة.
- استخدم المصطلحات الفنية الدقيقة:
خاطئ: استخدام github لتسجيل الدخول
صحيح: استخدام GitHub لتسجيل الدخول - استخدم علامات الاقتباس الزاوية للنص الصيني بدلاً من الاقتباسات العادية:
خاطئ: فريق الروبوت في هواقوان، المعروف أيضًا باسم "فريق الذئب البري"
صحيح: فريق الروبوت في هواقوان، المعروف أيضًا باسم「فريق الذئب البري」 - لا تستخدم علامات الترقيم بشكل متكرر للتأكيد.
أسلوب الكتابة
- لا تزيد الأشياء إلا إذا كانت ضرورية.
- من أجل زيادة قابلية القراءة، حاول تجنب استخدام الجمل الطويلة واستخدم الجمل البسيطة بدلاً منها.
- يجب أن يكون للحجج دعم من الأدلة، وتجنب الاعتماد على النظرية دون أمثلة.
المراجع والشكر
عنوان النص: https://wiki-power.com/
يتم حماية هذا المقال بموجب اتفاقية CC BY-NC-SA 4.0، يُرجى ذكر المصدر عند إعادة النشر.تمت ترجمة هذه المشاركة باستخدام ChatGPT، يرجى تزويدنا بتعليقاتكم إذا كانت هناك أي حذف أو إهمال.