إرشادات التدوين
لضمان أن تكون جميع تدوينات ZAP-Hosting متسقة من حيث الجودة والأسلوب، قمنا بإعداد مجموعة من الإرشادات التي يجب اتباعها عند إنشاء المحتوى لبرنامج مساهمة التدوين الخاص بنا. يجب عليك الالتزام بإرشاداتنا بدقة لضمان معالجة اقتراحاتك والمسودات اللاحقة بسرعة. والأهم من ذلك، سيضمن هذا أن يحصل قراؤنا على تجربة أفضل وأكثر اتساقًا وعالية الجودة أثناء قراءة تدويناتنا.
يمكن تقسيم إرشادات مساهمة التدوين إلى عدة أقسام رئيسية، وهي:
- الهيكل
- الأسلوب
- التنسيق
- المصطلحات
الهيكل
يجب أن تتبع تدويناتنا ضمن برنامج المساهمة هيكلًا نسبيًا متسقًا، يخلق اهتمامًا لدى القارئ ويوفر معلومات وأخبارًا له. سيعمل فريق مساهمات ZAP معك لضمان أن هيكلك مناسب عند إنشاء اقتراح تدوينة.
- عنوان الصفحة (H1)
- مقدمة (H2)
- التحضير (H2)
- الموضوع الرئيسي (H2)
- اختياري: موضوع فرعي 1 (H3)
- اختياري: موضوع فرعي 2 (H3)
- ...
- اختياري: موضوع آخر (H2)
- الخاتمة (H2)
نشجعك على استخدام عناوين H3 لإنشاء أقسام فرعية داخل أقسام H2 الرئيسية لتنظيم أجزاء أكبر من المحتوى إلى أقسام منظمة. يمكن رؤية مثال على ذلك في قسم الموضوع الرئيسي أعلاه.
إذا كنت تستخدم العناوين الفرعية، فمن المنطقي عادة أن يكون هناك عنوانان فرعيان أو أكثر ضمن العنوان الرئيسي، وإلا فلن يكون من المنطقي وجود عنوان فرعي واحد فقط ضمن عنوان رئيسي.
ضع في اعتبارك أن ما سبق هو مرجع تقريبي. قد يحتوي جسم تدوينتك على عناوين مختلفة حسب ما هو مناسب لمحتواك، لكن يجب أن تحتوي جميع التدوينات باستمرار على عنوان، مقدمة وخاتمة تحيط بمحتوى الجسم الرئيسي.
العناوين
يجب أن يكون عنوان تدوينتك قصيرًا وواضحًا وجذابًا لجذب انتباه القارئ. يجب أن يوضح بالضبط ما تدور حوله تدوينتك، هل هي أخبار أم نصائح وإرشادات؟ مثال على عنوان جيد هو: أفضل 10 سكربتات شرطة FiveM.
المقدمة
يجب أن تكون مقدمات تدويناتك قصيرة ومباشرة، عادة ما تتراوح بين جملة إلى جملتين. في المحتوى، يجب أن تهدف إلى وصف موضوع التدوينة بإيجاز والأهم من ذلك شرح ما ستقدمه التدوينة للقارئ، مع إعلامه بالهدف النهائي.
مثال على مقدمة مثالية لتدوينة تتعلق بـ SteamCMD سيكون:
- الجملة الأولى: SteamCMD هو أداة أساسية ضرورية لتثبيت سيرفرات مخصصة لمجموعة واسعة من الألعاب مثل Palworld وEnshrouded والمزيد.
- الجملة الثانية: في هذه التدوينة، سنستعرض عملية الإعداد الأولية لتثبيت SteamCMD على سيرفر Linux الخاص بك. سنستخدم Ubuntu في الأمثلة، لكن العملية ستكون مشابهة جدًا للتوزيعات الأخرى.
كما هو موضح في المثال، تلخص المقدمة بإيجاز المواضيع ذات الصلة في هذه التدوينة وتعرض الهدف العام للقارئ عند متابعة التدوينة.
التحضير
قسم التحضير مفيد لتوضيح أي متطلبات مسبقة يجب على القارئ تلبيتها قبل متابعة التدوينة. قد تكون هذه متطلبات برمجية أو عتادية، تعليمات لتحضير بعض البرامج مثل جدار ناري أو ببساطة إرشاد المستخدم لتسجيل الدخول إلى سيرفره عبر SSH أو RDP.
ننصح بشدة بتصفح موقعنا ZAP-Docs للبحث عن أدلة قد تغطي أو ترتبط بأي خطوات تحضيرية تخطط لإدراجها. إذا كان هناك دليل يغطي موضوعًا معينًا، مثل الوصول الأولي عبر SSH، يجب ربط الدليل وإبلاغ القارئ بمتابعته قبل المتابعة.
المتطلبات الشائعة لتدوينات المدونة تشمل:
- البرامج المطلوبة (مثل Git، Node.js، Python، Docker)
- دروس قد تساعد القارئ على اكتساب المعرفة الأساسية (مثل صفحة أخرى من ZAP-Docs)
- حسابات المستخدم مثل APIs
- الإعدادات المطلوبة (مثل DNS/SSL)
مثال على ذلك لتدوينة عن Reverse Proxy سيكون:
لإعداد reverse proxy ستحتاج إلى سيرفر Linux لاستضافة سيرفر البروكسي ويجب أن تتصل به. استخدم دليلنا [الوصول الأولي عبر SSH](vserver-linux-ssh.md) إذا كنت بحاجة للمساعدة في ذلك. ستحتاج أيضًا إلى الوصول إلى نطاق تملكه. لكل نطاق فرعي تخطط لاستخدامه، يجب إنشاء سجل DNS من نوع `A` يشير إلى عنوان IP الخاص بسيرفر Linux الخاص بك.
الموضوع الرئيسي
حان الوقت الآن لكتابة الجزء الأكبر من تدوينتك. نوصي بتقسيم التدوينة إلى عدة أقسام لمساعدة القارئ على البقاء متفاعلًا مع المحتوى. لا توجد متطلبات صارمة لكيفية تقسيمها، لكن كقاعدة عامة، حاول تقسيم كميات كبيرة من المحتوى إلى عدة عناوين. سيساعدك فريق مساهمات ZAP في ذلك طوال العملية.
إذا كانت تدوينتك تقدم معلومات إجرائية خطوة بخطوة أو دروسًا، فمن المنطقي تضمين رقم الخطوة ووصفًا قصيرًا للخطوة ضمن عنوان الموضوع الرئيسي، مثل الخطوة 1 - إنشاء المجلد. يجب أن تصف بإيجاز ما يفعله القارئ في الخطوة لتوفير هدف عام في الجملة الأولى. بين الخطوات، حاول إنشاء مقدمة قصيرة وعبارات انتقالية ختامية لإعلام القارئ بما أنجزه حتى الآن وما سيحدث في الخطوات التالية. هذه الانتقالات توفر سياقًا مهمًا للقارئ. حاول تجنب التكرار واستخدم مجموعة متنوعة من المصطلحات لتجنب إعادة الخطوات.
الخاتمة
أخيرًا، القسم الأخير هو خاتمة التدوينة. يجب أن يغلق هذا القسم الدليل في 1-3 جمل تشرح ما نجح القارئ في تحقيقه أو تعلمه أو لتقديم خاتمة لدليل معلوماتي.
كما سيكون من المنطقي تقديم مراجع لقراءات إضافية أو تدوينات أو أدلة أخرى يمكن للمستخدم متابعتها لتوسيع معرفته في الموضوع. يجب ربط أي أدلة أو تدوينات ZAP-Docs موجودة هنا، خاصة إذا كانت تتبع بشكل طبيعي من دليلك.
الأسلوب
أسلوب الكتابة في وثائق ZAP-Hosting يتبع إيماننا بإنتاج تدوينات عالية الجودة وعملية وسهلة الوصول لدعم مجموعة واسعة من المواضيع ودعم القراء من جميع مستويات الخبرة.
تقني وصحيح
تهدف تدويناتنا لأن تكون دقيقة تقنيًا قدر الإمكان ومحدثة بأحدث المعلومات في الصناعة. نتوقع تقديم معلومات مكتوبة جيدًا وعالية الجودة حول مواضيع وتقنيات جديدة بالإضافة إلى دروس تركز على تعلم القارئ لمعلومات جديدة. إذا كانت تدوينتك تقدم معلومات إجرائية خطوة بخطوة أو درسًا، يجب أن يكون لكل خطوة هدف واضح وشرح، مع توفير خيارات إضافية و/أو علامات حيثما كان ذلك مناسبًا.
يجب على الكتاب دائمًا مراجعة واختبار تدويناتهم لضمان أن كل شيء صحيح تقنيًا ويعمل كما هو مقصود قبل تقديم المسودات. سيقرأ فريق مساهمات ZAP تدوينتك ويختبرها حيثما كان ذلك مناسبًا لضمان الاتساق والصحة الواقعية أو مناقشة التحسينات إذا وُجد خطأ.
ننصح دائمًا كتابنا بتمرير المحتوى عبر أداة تدقيق إملائي ونحوي لضمان صحة SPAG قبل تقديم المسودة. موقع مفيد لذلك هو: https://languagetool.org/
عملي ومفيد
بحلول الوقت الذي ينهي فيه القارئ قراءة تدوينة، يجب أن يكون قد تعلم أو بنى أو أعد شيئًا من البداية للنهاية. تهدف تدويناتنا لدعم القراء من أي مستوى خبرة، لذلك يجب أن تغطي محتويات تدوينتك الموضوع بشكل كامل لضمان أن يصبح القارئ ملمًا و/أو قد حقق شيئًا. ككاتب، يعني هذا أنه يجب عليك تغطية موضوعك بدقة، مع توفير كل التفاصيل اللازمة بما في ذلك المتطلبات المسبقة حيثما كان ذلك مناسبًا. يجب أن توجه القراء إلى مواقع خارجية فقط إذا لم يكن هناك توثيق موجود على ZAP Docs أو إذا كان ذلك للسماح للقارئ بجمع تفاصيل إضافية ليست ضرورية لمقالك لكنها قد تفيد في بناء معرفته التقنية. يجب ألا توجه الروابط الخارجية إلى توثيق المنافسين.
ودود، رسمي وشامل
نتوقع أن تكون وثائقنا متقدمة وودية لجعلها سهلة الوصول لأي قارئ، ولكن في نفس الوقت تبقى رسمية. طوال تدوينتك، يجب أن تهدف إلى أن يكون أسلوب كتابتك مقبولًا لجميع القراء، بغض النظر عن الخبرة أو الحواجز اللغوية.
نظرًا لأن هذه تدوينات تركز بشكل أساسي على دعم القارئ للتعلم والوصول إلى نتيجة، نتوقع من الكتاب استخدام صيغة المخاطب (مثل "أنت تحتاج إلى...") بدلاً من صيغة المتكلم (مثل "أعتقد...") للحفاظ على تفاعل القارئ وتركيز الانتباه عليه.
أخيرًا، يجب على جميع الكتاب الالتزام بمدونة السلوك الخاصة بنا لضمان أن تدويناتنا مقبولة لأي شخص بغض النظر عن العمر، العرق، الهوية الجنسية، مستوى الخبرة، الجنسية، الدين، الانتماء السياسي، التوجه الجنسي، الوضع الاجتماعي الاقتصادي أو اختيارات التكنولوجيا. يجب تجنب أي لغة قد تكون مسيئة أو أي محتوى يشير إلى المواضيع المذكورة أعلاه.
التنسيق
مدونتنا منسقة باستخدام لغة ترميز Markdown الشائعة الاستخدام. استخدم الأقسام أدناه لفهم العناصر التي نستخدمها وكيف يمكن استخدامها في تدويناتك.
نسمح للمستخدمين باستخدام أي أدوات كتابة لإنشاء المحتوى، لكننا نوصي بشدة باستخدام أداة StackEdit لكتابة المحتوى مع الحفاظ على كل ميزات Markdown الرائعة. يمكنك بعد ذلك تصدير المحتوى مباشرة إلى Google Drive أو أي تطبيق مشاركة ملفات والحصول على رابط يمكنك مشاركته معنا.
لمزيد من الأمثلة والشروحات المفصلة لميزات Markdown، توجه إلى Markdown Guide الذي يوفر معلومات إضافية.
العناوين
العناوين هي واحدة من أهم خيارات التنسيق المستخدمة لفصل التدوينات بشكل شامل ومنطقي. العنوان الرئيسي يتكون من عنوان H1.
في تدويناتنا، يجب استخدام عناوين H2 لتقسيم التدوينة إلى أقسامها الرئيسية. بعد ذلك، تستخدم عناوين H3 لتقسيم الأقسام الرئيسية إلى أقسام فرعية. مثال مناسب هو تقسيم قسم رئيسي إلى عدة خطوات لتسهيل متابعة التدوينة. وأخيرًا، هناك أيضًا علامة H4 التي تُستخدم نادرًا لكنها تخدم نفس الغرض في تقسيم الأقسام الفرعية.
إذا كنت تستخدم عناوين فرعية (مثل عناوين H3 تحت عناوين H2 الرئيسية)، تأكد من وجود عنوانين أو أكثر من نفس المستوى ضمن ذلك القسم، وإلا سيكون الاستخدام غير صحيح.
إليك مثال سريع لكيفية استخدام العناوين:
## التثبيت
H2 - قسم رئيسي
### تحميل ملفات اللعبة
H3 - قسم فرعي من H2
#### عبر SteamCMD
H4 - قسم فرعي من H3
#### يدويًا عبر GitHub
H4 - قسم فرعي من H3
### تحضير الإعدادات
H3 - قسم فرعي من H2
### بدء السيرفر
H3 - قسم فرعي من H2
تنسيق داخل السطر
نستخدم مجموعة من التنسيقات داخل السطر لتحسين قابلية قراءة تدويناتنا وتناسب القراء بمستويات تقنية مختلفة. اقرأ القسم أدناه لفهم استخدام كل منها.
النص العريض
الاستخدام الرئيسي للنص العريض هو لتأكيد المعلومات. أمثلة على ذلك تشمل:
- تغيير السياق بين الخطوات
- أسماء المضيف، بيانات الاعتماد وأسماء المستخدمين
- المصطلحات الرئيسية
يمكنك ببساطة استخدام نجمتين مزدوجتين خارج النص لجعله عريضًا، مثل **مرحبًا هناك**
ينتج مرحبًا هناك.
النص المائل
الاستخدام الأساسي للنص المائل هو تقديم كلمات تقنية جديدة داخل مقالك. على سبيل المثال، سنقوم اليوم بإعداد reverse proxy.
لاستخدام النص المائل، ضع نجمة واحدة خارج النص، مثل *ZAP-Hosting - المزيد من القوة!*
ينتج ZAP-Hosting - المزيد من القوة!.
كود داخل السطر
يُستخدم تنسيق الكود داخل السطر بشكل رئيسي لعرض معلومات تقنية مثل عناوين URL. قائمة أكثر شمولاً تشمل:
- أسماء ومسارات الملفات (مثل
C:/User/[YourName]/AppData....test.png
) - عناوين URL (مثل
https://zap-hosting.com
) - المنافذ (مثل
:30120
) - الأوامر (مثل
ipconfig
) - استعلامات SQL (مثل
SELECT * FROM servers
) - اختصارات لوحة المفاتيح (مثل
ENTER
أوCTRL + C
)
الجداول
ميزة Markdown المفيدة الأخرى هي الجداول. تكون مفيدة بشكل خاص عند الحاجة لعرض كمية كبيرة من المعلومات المتكررة، مثل الأوامر، الوصف والاستخدامات المتاحة داخل لعبة. مثال على استخدام الجدول:
| الأمر | الوصف | الاستخدام |
| ----------- | ----------------------- | --------------------- |
| /help | يرسل أمر المساعدة | /help [الفئة] |
| /stop | يوقف السيرفر | /stop [true/false] |
كتل الكود
أداة تنسيق Markdown مفيدة جدًا أخرى هي كتل الكود. تكون مفيدة بشكل خاص للتدوينات التي تتضمن استخدام أوامر، سكربتات، مخرجات الطرفية والمزيد.
لاستخدام كتلة كود، استخدم ```
خارج النص الذي تريد وضعه في كتلة. يمكنك أيضًا ذكر اللغة بجانب الثلاث علامات الأولى لتنسيق لغة البرمجة بشكل صحيح. مثال على استخدام كتلة كود بلغة JavaScript:
function hello(name) {
console.log(name)
}
var server = "ZAP-Hosting"
hello(server)
لقطات الشاشة
لقطات الشاشة طريقة مفيدة جدًا لإرشاد القراء خلال الخطوات بصريًا ونوصي بشدة باستخدامها حيثما كان ذلك مناسبًا.
يمكنك استخدام الصيغة التالية لإضافة لقطة شاشة إلى المحتوى، مع استبدال your_url
برابط الصورة:

أفضل ممارسة هي استخدام موقع استضافة صور عبر الإنترنت مثل Imgur لرفع الصورة واستخدامها في Markdown.
المصطلحات
طوال تدويناتنا، سيكون هناك مجموعة واسعة من المصطلحات الرئيسية المستخدمة. نتوقع منك استخدام التهجئة الأمريكية الإنجليزية الموحدة لضمان الاتساق عبر جميع تدويناتنا. في هذا القسم، نهدف إلى توحيد بعض المصطلحات التي من المرجح أن تُستخدم بشكل شائع.
منتجات ZAP-Hosting
عند الإشارة إلى منتج من ZAP-Hosting، يجب دائمًا التأكد من استخدام الاسم الصحيح، التهجئة والحروف الكبيرة. يمكنك التحقق من ذلك بزيارة موقع ZAP-Hosting ومراجعة كيفية الإشارة إلى المنتج في الموقع المعني.
السمات المعرفة من قبل المستخدم
في بعض التدوينات، قد تحتاج إلى خيارات تكوين لعناصر مثل المستخدمين، أسماء المضيف، النطاقات، عناوين IP وعناوين URL، حيث يجب على القارئ استخدام بياناته الخاصة بدلًا من العناصر النائبة.
بشكل افتراضي، يجب دائمًا استخدام [your_attribute]
للتمييز بين العناصر الثابتة والفريدة، حيث يجب استبدال [attribute]
بنوع السمة. على سبيل المثال، عند ذكر IP، يجب ذكر [your_server_ip]
في التدوينة أو عند ذكر URL يجب ذكر http://[your_server_ip]:30120
. هذا يوضح بجلاء السمات التي يجب على القارئ تغييرها بناءً على تكوينه الخاص. يجب أيضًا تقديم شرح أو ملاحظة تخبر القارئ بالسمات التي يحتاج لتغييرها عند ذكرها لأول مرة لضمان الفهم الكامل.
يجب استخدام zaphosting
كاسم مضيف، اسم مستخدم أو اسم قاعدة بيانات افتراضي.
البرمجيات
عند ذكر برمجيات في تدوينتك، يجب التأكد من اتباع التهجئة الصحيحة واستخدام الحروف الكبيرة لاسم البرنامج. إذا لم يكن موقع البرنامج متسقًا في استخدام الحروف الكبيرة، تأكد من اتباع نفس التهجئة داخل المقال الواحد للحفاظ على الاتساق.
يجب ربط اسم البرنامج بموقعه الرسمي عند ذكره لأول مرة، إذا كان الموقع الرسمي متاحًا.