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

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

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

آخر تحديث لهذه الصفحة: 25/05/2021

فهرس الصفحة:

• قواعد متعلقة بالكتابة
• قواعد متعلقة بتحقيق سهولة القراءة
• قواعد متعلقة بالصور

قواعد متعلقة بالكتابة

1. استخدم محرّرًا متقدمًا لكتابة مقالاتك وثبّت/فعّل المدقّق اللغوي عليه، فيضيع وقت كبير في تصحيح أخطاء كان من الممكن تجنّبها لو استُخدم مُحرر مُتقدّم.

2. لا تضع مسافةً بعد القوس الأول المفتوح ولا قبل القوس الثاني مثل ( قوس ) بل يجب إزالة الفراغات بقول (قوس)، وتجنب إضافة المصطلحات الأجنبية بجانب العربية بين القوسين بل اذكرها بجانبها مباشرةً مثل: "تعدّ الوسوم tags أساس مستندات HTML. " ولا نضع المصطلح الأجنبي tags بين القوسين بجانب العربي.

3. لا تضف مسافةً بعد حرف العطف "و" وألصقه بالكلمة التي تليه.

4. التنوين يكون على الحرف وليس على ألف الإطلاق التي تليه مثل محتوًى وغارقًا.

5. تجنب الفقرات المكونة من جُملة واحدة.

6. إذًا وليس إذن (رغم وجود خلاف بين النحاة في ذلك).

7. شكِّل الكلمات التي يمكن أن تلتبس على القارئ لاحتمال قراءتها على أكثر من وجه فقط ولا تضف التشكيل على الكلمات في غير تلك المواضع القليلة.

8. إن كنت تستخدم محرر نصوص مُتقدّم فيجب أن تستعمل أنماط التنسيق مع العناوين وتحترم مستوياتها ولا تكتفي بجعل العنوان نصًا بارزًا.

9. عنوان المقال الرئيسي يكون من المستوى الأول H1 (أي # بتنسيق مارك داون)، وعناوين أقسام المقال تكون من المستوى الثاني H2 (أي ##) والعناوين الفرعية لتلك الأقسام من المستوى الثالث H3، وهكذا دواليك.

10. يفضَّل ترقيم العناوين ذات المُستوى الثالث H3 بأرقام (على شكل 1- ، 2- ..) إن كان ذلك مناسبًا للمحتوى وتتم إضافة ذلك يدويًا ولا تترك مهمة إضافتها للمُحرر.

11. لا تضع ":” في نهاية العناوين سواء كانت عناوين أقسام المقال أو عناوين فرعية.

12. لا تضع خطًا تحت أيّ من عناوين المقال الرئيسية أو الفرعية ولا تجعل هذه العناوين غليظة (أي تنسيق bold) أي لا تضف أي تنسيق على العناوين.

13. لا تضف الروابط إلى العناوين، وإن دعت الحاجة لإضافة رابط فأضفه في الفقرة التي تلي العنوان.

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

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

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

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

18. لا تستخدم الجمل الاسمية التي يمكن تحويلها إلى جمل فعلية بمجرد إعادة ترتيب كلمات الجملة مثل أسلوب اللغة الإنجليزية التي تعتمد كليًا على الجمل الاسمية. أي لا تكتب "القلم يكتب جيدًا على الورقة" بل اكتب "يكتب القلم جيّدًا على الورقة".

19. يقع المُترجم عادةً في فخ الحفاظ على بنية جُملة الانجليزية بعد ترجمتها إلى العربية، والأهم هو المحافظة على المعنى وليس على هيئة الجملة.
    من بين المشاكل المتكررة استخدام الجمل الاسمية في غير محلها مثل:
    the book was good and my brother bought it for me
    تترجم إلى:
    «الكتاب كان جيدا وأخي اشتراه لي.»
    في حين لو كتبنا الجملة بالعربية كتابة سليمة فصيحة لكانت على النحو:
    «وجد أخي الكتاب جيدًا، فاشتراه لي.»
    كما تُلاحظ هنا الجملة الثانية أفضل بكثير من الأولى ويظهر جليًا بأن الجُملة الأولى ركيكة بسبب المحافظة على بنية الجملة الإنجليزية.

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

21. لا تضف/تقل «انقر هنا» ومن ثم تضيف الرابط عليها، بل أضف الرابط مباشرة إلى النص (يعني اجعل النص قابلًا للنقر) أو اذكر اسم الصفحة التي تشر إليها وضع عليها الرابط.

22. لا داعي لأية عبارات ذات طابع ديني (كالبسملة أو غيرها).

23. لا تستعمل كلمة «قام» و «تم» و «كان» في غير مواضعها لتكون ترجمةً للأفعال المساعدة في اللغة الإنجليزية بل استعمل الفعل مباشرةً وشكله إن لزم الأمر. فلا تقل: «الموقع قام بعرض المنتجات» أو «تم تثبيت الإضافة بنجاح» أو «كان يكتب رسالةً» بل قل: «عرض الموقع المنتجات» و «ثُبِّتت الإضافة بنجاح» و «كتب الرسالة».

24. حول الجمل التي فيها ضمير متكلم إن كانت الصفحة مترجمة وانسبها إلى كاتبها، فلا تترجم مثلًا: «أجرى فريقنا بحثًا حول كذا» ترجمةً حرفيةً، بل قل: «أجرى فريق موقع [الموقع الذي تترجم منه] بحثًا حول كذا» وهلم جرًا.

25. تذكَّر أن المقال موجه للعرب والعالم العربي، لذا أزل أي نصوص مخلة بالأدب ولا تناسب عالمنا العربي وحول كل شيء بما تراه مناسبًا مع السياق؛ فلا تقل: متوسط رواتب الأجور في أمريكا كذا، بل حاول البحث عن مرجع لمتوسط الأجور في أي بلد عربي وأضفه إن ناسب السياق، ولا تقل أيضًا: «كان الشتاء الماضي قاسيًا بالنسبة لي. كان الأطفال في المدرسة وكان شريكي يساعدني في تدبر أمور المنزل» بل نقول: «... كان زوجي ...».

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

قواعد متعلقة بتجربة القراءة

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

1. لا تضف أية أقواس للمصطلحات الأجنبية الموضوعة بجانب العربية، أي عند ذكر المصطلحات الأجنبية، نضعها مباشرةً بجانب العربية دون أقواس، فيكثر في المحتوى البرمجي ذكر المصطلحات البرمجية الأجنبية ولا نريد إغراق النص بالأقواس هنا وهناك.
2. تجنب إضافة التشكيل على الكلمات إلا في الحالات الضرورية جدًا (بعض مواضع الشدة وتنوين الفتح عند وجود ألف الإطلاق وحالات الفعل المبني للمجهول) التي يؤكد فيها أن  قراءة الكلمة ستُشكِل قراءتها على القارئ، ولنتذكر أن التشكيل وضع لتسهيل قراءة النص على غير الناطقين بالعربية أو من لغته العربية ضعيفة، وتذكر أن النص العربي بالأساس لم يكن منقوطًا حتى العصر الأموي وكان يقرأ بسهولة آنذاك. الخلاصة، إضافة التشكيل يعيق من قراءة النص ويبطئ من سرعة القراءة ولن يحقق تجربة قراءة جيدة.  (انظر لمزيد من التفاصيل الفصل التاسع: التشكيل والضبط من كتاب «عزيزي المحرر» لمحمود عبد الرزاق جمعة).
3. قلل من إضافة تنسيق شيفرة سطرية inline code ضمن النص العربي، إذ إضافة نص أجنبي بجانب نص عربي لا يحقق تجربة قراءة جيدة، لأن اتجاه النص العربي من اليمين إلى اليسار بينما اتجاه النص الأجنبي من اليسار إلى اليمين فكيف إذا أضفنا شيفرة -نص أجنبي منسق بتنسيق عرض ثابت لأحرفه. نلجأ في بعض الحالات إلى تغيير حالة الشيفرة السطرية إلى شيفرة كتلية بوضعها على سطر منفصل (انظر المثال في الأسفل).
4. تحري عدم الفصل بين عناصر قائمة بفاصل فأحيانًا يكون لعنصر قائمة شرح مطول مع أمثلة وشيفرات عليه، فنجعل آنذاك تنسيق تلك العناصر ضمن عناوين من مستوى مناسب ونجعل الشرح والفقرة ضمنها.
5. إزالة الروابط الداخلة التي تشير إلى صفحات ومقالات أجنبية وتبديلها إلى صفحات عربية مقابلة مثلًا بدلًا من الإشارة إلى صفحة ويكيبيديا أجنبية نبدلها إلى الصفحة نفسها باللغة العربية. نذكِّر أننا نستهدف القراء العربي وإحالة القارئ العربي إلى مقال أجنبي يعد تجربة قراءة تعيسة لذا نحرص على توجيه القارئ العربي إلى المقالات والصفحات العربية.

أمثلة

المثال الأول

إليك الفقرة التالية:

إذا كان ‎T‎ من النوع ‎ClassTemplate<TemplateArguments>‎ -وهو صنف أيضًا-، تُضاف الأصناف وفضاءات الاسم المرتبطة بوسائط نوع القالب، وفضاء الاسم الخاص بوسائط قالب القالب (template template argument)، والصنف المحيط بوسائط قالب القالب، إذا كان وسيط القالبِ (template argument) قالبَ عضوٍ (member template).

يمكن تحسينها إلى الشكل التالي:

إذا كان ‎T‎ من النوع التالي:

‎ClassTemplate<TemplateArguments>‎

وهذا النوع هو صنف أيضًا، فتضاف الأصناف وفضاءات الاسم المرتبطة بوسائط نوع القالب، وفضاء الاسم الخاص بوسائط قالب القالب template template argument، والصنف المحيط بوسائط قالب القالب، إذا كان وسيط القالب template argument قالب عضو member template.

المثال الثاني

إليك مثال آخر:

إذا كان ‎T‎ مؤشّرًا يشير إلى عضو، تُضاف الأصناف وفضاءات الأسماء المرتبطة بنوع ذلك العضو (قد تنطبق على كل من مؤشّرات التوابع ومؤشّرات الحقول). في مثال ‎‎B A::*p; void (A::*pf)(B); f(p);f(pf);‎؛ تُضاف فضاءات الأسماء والأصناف المرتبطة بـ A‎ و B‎ و void(B)‎، والتي تطبّق القواعد أعلاه التي تخصّ أنواع الدوال.

يمكن تحسينها إلى الشكل التالي:

إذا كان ‎T‎ مؤشرًا يشير إلى عضو، تضاف الأصناف وفضاءات الأسماء المرتبطة بنوع ذلك العضو (قد تنطبق على كل من مؤشّرات التوابع ومؤشّرات الحقول). ففي المثال التالي:

B A::*p; void (A::*pf)(B); f(p);f(pf);

تضاف فضاءات الأسماء والأصناف المرتبطة بـ A‎ و B‎ و void(B)‎، والتي تطبّق القواعد أعلاه التي تخص أنواع الدوال.

لاحظ الفرق في سهولة القراءة بين الفقرتين.

المثال الثالث

إليك مثال آخر لفقرة تعد تعيسة من ناحية تحقيق تجربة قراءة مميزة:

يُسمح بتعريف مُتغير مُضمّن (Inline variable) في عدّة وحدات ترجمة دون انتهاك قاعدة التعريف الواحد. وفي حال تعريف متغيّر مُضمّن أكثر من مرة، فسيَدمِج الرابط (linker) كلّ تَعاريفه في كائن واحد في البرنامج النهائي.

يمكن تعريف حقل ساكن (static data member) في صنف إن صُرِّح عنه بأنّه مُضمّن (‎inline‎). على سبيل المثال، يمكن تعريف الصنف في المثال التالي في الترويسة.

ملاحظة: قبل C++‎ 17، كان من الضروري توفير ملفّ ‎.cpp‎ لاحتواء تعريف Foo::num_instances كي نضمن ألا يُعرّف أكثر من مرّة واحدة، لكن في C++‎ 17، أصبحت مُختلف تعريفات المتغيّر المضمن ‎Foo::num_instances‎ تشير إلى نفس الكائن ‎int‎.

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

قواعد متعلقة بالصور

1. إن احتوى المقال على صور فيجب أن تُرفق في مجلد imgs ويستحب أن ترقم الصّور حسب ترتيب ظهورها في المقال وأن تحمل أسماءً تعبر عن مُحتواها. الترقيم يجب أن يكون على شكل 001، 002 ...إلخ.

   مثال عن اسم صورة صحيح:

   Export_PDF_in_InDesign.jpg

   مثال عن اسم صورة غير صحيح:

   
   pic05x.png

2. يجب أن تكون الصور واضحة جيدة الدقة.

3. تجنب وضع أطر (أيًا كان لونها حول الصور).

4. يجب أن يكون اسم الصور دالّا على محتواها (ويُفضّل إضافة ترتيب ظهورها في المقال إلى اسمها في حال ما إذا تمّ تسليم المقال ولم يقم الكاتب بإضافته مُباشرة) ويكتب اسمها في المقال بالشكل [001imageName.png] أي وضع اسم الصورة كاملًا مع اللاحقة ضمن القوسين [ ].

5. يجب أن تكون أحجام صور المقال متناسقة، ويفضل استعمال تطبيقات تخفض الحجم مع تحقيق أفضل جودة مثل تطبيق tinypng.com.

6. إن كان الصور تحوي نصوصًا أجنبية، فترجم النصوص وأضف ترجمة محتوى الصورة إلى ملف نصي منفصل في مجلد صور المقال.

7. لا تضف أية روابط على الصور.