إرشادات الدليل
لضمان بقاء المحتوى في ZAP-Docs دائمًا متسقًا من حيث الجودة والأسلوب، أنشأنا مجموعة من الإرشادات لاستخدامها عند إنشاء أو تعديل المحتوى الخاص بتوثيقنا. يجب عليك اتباع إرشاداتنا بدقة لضمان معالجة اقتراحك وطلب السحب النهائي بسرعة. والأهم من ذلك، سيضمن هذا أن يحصل قراؤنا على تجربة أفضل وأكثر اتساقًا وعالية الجودة أثناء قراءة الأدلة ومتابعتها.
تنقسم إرشادات مساهمات الأدلة إلى الأقسام التالية:
- الهيكل
- الأسلوب
- التنسيق
- المصطلحات
ننصحك بتصفح هذه الأقسام مرة واحدة على الأقل قبل البدء في كتابة أي محتوى. كما أنها مكان مفيد للرجوع إليه إذا كنت غير متأكد من كيفية التعامل مع شيء ما أثناء عملية الإنشاء.
الهيكل
جميع أدلتنا عبر ZAP-Docs تتبع هيكلًا نسبيًا متسقًا يبدأ بمقدمة قصيرة مع أي متطلبات مسبقة أو خطوات تحضيرية، تليها المحتوى الرئيسي وخاتمة قصيرة.
يمكن تعديل الهيكل أحيانًا حسب نوع الدليل المنتج. يمكن مناقشة ذلك مع فريق ZAP-Docs ضمن اقتراحك الأولي. يمكنك الاطلاع على كيفية استخدام العناوين عبر قسم العناوين، ويتم ذلك من خلال Markdown التقليدي العادي.
الهيكل الذي نتوقع رؤيته عادةً يحتوي على العناوين التالية:
- عنوان الصفحة (H1) - يتم تعيينه عبر بيانات التعريف
title
في أعلى الصفحة. - مقدمة (H2) - جملة أو جملتان موجزتان تشرح موضوع الدليل والأهم توضح ما يهدف الدليل لتحقيقه.
- التحضير (H2) - هذا العنوان اختياري. يُستخدم فقط إذا كانت هناك متطلبات مسبقة أو خطوات تحضيرية يجب تنفيذها قبل أن يتمكن القارئ من متابعة الدليل. على سبيل المثال، هنا يمكنك الإشارة إلى دليلنا الوصول الأولي عبر SSH إذا كان يجب على المستخدم تسجيل الدخول إلى سيرفره أولاً. أو يمكنك عرض أي متطلبات برمجية و/أو مادية. أو تقديم تعليمات سريعة حول كيفية تحضير بعض البرمجيات، مثل جدار ناري. ننصح بتصفح موقع ZAP-Docs لمعرفة ما إذا كانت هناك أدلة تغطي هذه الخطوات وإذا كان الأمر كذلك، قم بربطها.
- الموضوع الرئيسي (H2) - هذا هو القسم الرئيسي الأول من الدليل. في كثير من الحالات، سيكون هذا العنوان التثبيت، يليه عدة أقسام فرعية لكل جزء من العملية. لكن قد لا يكون هذا هو الحال دائمًا، فالأدلة المعلوماتية قد تحتوي على موضوع رئيسي مختلف.
- اختياري: موضوع فرعي 1 (H3)
- اختياري: موضوع فرعي 2 (H3)
- ...
- اختياري: موضوع آخر (H2)
- الخاتمة (H2) - كجزء نهائي من الدليل، يجب أن تختم الدليل في 1-3 جمل تشرح ما حققه القارئ بنجاح وتوفر مرجعًا لفريق الدعم إذا كان القارئ لا يزال يواجه مشاكل.
نشجعك على استخدام عناوين H3 لإنشاء أقسام فرعية داخل أقسام H2 الرئيسية لتنظيم المحتوى الأكبر إلى أقسام منظمة. مثال على ذلك يمكن رؤيته في قسم الموضوع الرئيسي أعلاه.
يمكنك أيضًا استخدام عناوين H4. هذه مفيدة إذا أردت إنشاء قسم فرعي آخر دون عرضه في قائمة الأقسام على الجانب الأيمن من الدليل. كما أنها مفيدة إذا كنت بحاجة إلى تقسيم قسم H3 إلى أقسام أصغر.
إذا كنت تستخدم العناوين الفرعية، فمن المنطقي عادةً أن يكون هناك عنوانان فرعيان أو أكثر ضمن العنوان الرئيسي، وإلا فلن يكون من المنطقي وجود عنوان فرعي واحد فقط ضمن عنوان رئيسي.
في المستقبل، سنضيف قوالب تحتوي على Markdown معد مسبقًا لك، والتي ستكون نقطة انطلاق مفيدة لإنشاء صفحات جديدة. سيتم إضافتها قريبًا.
العناوين
يجب أن تكون عناوين أدلتك قصيرة ومبنية على الهدف العام للدليل الذي كتبته. فكر جيدًا فيما سيحققه القارئ بنهاية الدليل، مثل تثبيت برنامج معين أو تقديم معلومات حول موضوع محدد.
يجب أن يسبق العنوان فئة المنتج التي يرتبط بها الدليل، والتي يجب أن تكون أيضًا المكان الذي وضعت فيه الدليل في الشريط الجانبي. يمكنك بسهولة التحقق من أدلة أخرى في نفس القسم لرؤية بادئ العنوان الخاص بها.
مثال على عنوان جيد لدليل يتعلق بمنتج VPS هو: VPS: إعداد SteamCMD على Linux
المقدمة
يجب أن تكون مقدمات أدلتك قصيرة ومباشرة، عادةً ما تتراوح بين 1-2 جمل. في المحتوى، يجب أن تهدف إلى وصف موضوع الدليل بإيجاز والأهم من ذلك شرح ما سيقدمه الدليل للقارئ، مع إعلامه بالهدف النهائي.
مثال على مقدمة مثالية لدليل يتعلق بـ 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.
الموضوع الرئيسي
حان الوقت الآن لكتابة الجزء الأكبر من دليلك. يمكنك استخدام عناوين H2 وH3 وH4 لتنظيم دليلك بشكل مناسب. من المنطقي استخدام عناوين H2 للأقسام الكبيرة وتقسيمها إلى أقسام فرعية باستخدام H3 و/أو H4.
في كثير من الحالات، خاصة أي دليل يغطي عملية إعداد برنامج، من المحتمل أن تستخدم عنوان التثبيت مقسمًا إلى عدة أقسام فرعية H3. إذا كنت تواجه صعوبة في تحديد الهيكل الصحيح، لا تقلق، سنعمل معك خلال مرحلة الاقتراح لتخطيط هيكل دليل متكامل.
داخل كل قسم، يُنصح عادةً بإضافة جمل انتقالية قصيرة في البداية والنهاية لإعلام القارئ بما أنجزه حتى الآن وما سيقوم به بعد ذلك. بالطبع، هذا لا ينطبق على القسم الرئيسي الأخير الذي لا يحتاج بالضرورة إلى جملة ختامية، لأنه ينتقل طبيعيًا إلى الخاتمة.
مثال على هذه الجمل:
- جملة الدخول: في هذا القسم، ستقوم بعملية التهيئة لتخصيص البرنامج حسب رغبتك.
- جملة الإغلاق: مع الانتهاء من التهيئة وحفظ الملف، انتقل إلى القسم التالي لإعداد حساب المسؤول وبدء استخدام البرنامج.
من خلال هذه الجمل الانتقالية، يحصل القارئ على سياق مهم يضمن تدفق الدليل بشكل جيد. تذكر، يجب عليك دائمًا استخدام صيغة المخاطب (مثل "ستقوم بإنشاء") بدلاً من صيغة المتكلم عند كتابة المحتوى والجمل الانتقالية.
الخاتمة
أخيرًا، القسم الأخير هو خاتمة الدليل. يجب أن يختم هذا القسم الدليل في 1-3 جمل تشرح ما حققه القارئ بنجاح وتوفر مراجع لقراءات إضافية أو أدلة يمكنهم متابعتها لتوسيع معرفتهم بالموضوع.
من الجيد ربط أي أدلة موجودة في ZAP-Docs هنا، خاصة إذا كانت تتبع منطقيًا من دليلك. كما نوصي بتوفير مرجع لفريق الدعم إذا كان القارئ لا يزال يواجه مشاكل.
مثال على خاتمة رائعة هو:
لقد قمت الآن بإعداد البرنامج بنجاح ليعمل على سيرفر Linux الخاص بك! ننصح بتصفح أدلة خدمات Linux الموجودة في هذا القسم لتثبيت خدمات إضافية.
لأي أسئلة أو مساعدة، لا تتردد في التواصل مع فريق الدعم لدينا، المتوفر يوميًا لمساعدتك! 🙂
الأسلوب
أسلوب الكتابة في وثائق ZAP-Hosting يعكس إيماننا بإنتاج أدلة عالية الجودة وعملية وسهلة الوصول تدعم مجموعة واسعة من المواضيع وتدعم القراء من جميع مستويات الخبرة.
دقيق وتقني
تهدف مقالاتنا لأن تكون دقيقة تقنيًا قدر الإمكان ومحدثة بأحدث المعلومات في الصناعة. نتوقع أن لا تقتصر المقالات على تمكين المستخدم من تحقيق الهدف النهائي من التعلم أو البناء أو الإعداد، بل أيضًا لفهم ما قام به خلال المقال. يجب أن يكون لكل خطوة تنشئها في الدليل غرض واضح وشرح، مع توفير خيارات إضافية و/أو علامات حيثما كان ذلك مناسبًا. يجب عليك دائمًا إبقاء القارئ على اطلاع بما يفعله ولماذا يقوم بهذه الإجراءات التي هي جزء من الدليل.
يجب على الكتاب دائمًا مراجعة أدلتهم واختبارها لضمان أن كل شيء صحيح تقنيًا ويعمل كما هو مقصود قبل تقديم طلب السحب. سيقوم فريق وثائق ZAP-Hosting بقراءة واختبار دليلك حيثما كان ذلك مناسبًا لضمان اتساقه وصحته الواقعية أو مناقشة التحسينات إذا وُجد خطأ.
ننصح دائمًا كتابنا بتمرير المحتوى عبر أداة تدقيق إملائي لضمان صحة القواعد والإملاء قبل إنشاء طلب السحب. موقع مفيد لذلك هو: https://languagetool.org/
عملي ومفيد
بحلول الوقت الذي ينهي فيه القارئ المقال، يجب أن يكون قد تعلم أو بنى أو أعد شيئًا من البداية للنهاية. تهدف أدلتنا إلى دعم القراء من أي مستوى خبرة، لذلك يجب أن تغطي مساهماتك الموضوع بشكل كامل لضمان أن يصبح القارئ ملمًا و/أو قد حقق شيئًا. هذا يعني أنه ككاتب، يجب أن تغطي موضوعك بدقة مع ذكر كل التفاصيل اللازمة بما في ذلك المتطلبات المسبقة. يجب أن ترسل القراء إلى مواقع خارجية فقط إذا لم يكن هناك توثيق موجود على ZAP-Docs أو إذا كان ذلك للسماح للمستخدم بجمع تفاصيل إضافية ليست ضرورية لمقالك لكنها قد تفيد في بناء معرفتهم التقنية. يجب ألا توجه الروابط الخارجية إلى توثيق المنافسين.
ودود، رسمي وشامل
نتوقع أن يكون توثيقنا متقدمًا وودودًا ليكون سهل الوصول لأي قارئ، لكنه في نفس الوقت يبقى رسميًا. طوال دليلك، نهدف لأن يكون أسلوب الكتابة مقبولًا لجميع القراء، بغض النظر عن الخبرة أو الحواجز اللغوية.
نظرًا لأن هذه الأدلة تركز بشكل أساسي على دعم القارئ للتعلم وتمكينه من الوصول إلى نتيجة، نتوقع من الكتاب استخدام صيغة المخاطب (مثل "تحتاج إلى...") بدلاً من صيغة المتكلم (مثل "أعتقد...") للحفاظ على تفاعل القارئ وتركيز الانتباه عليه.
أخيرًا، يجب على جميع الكتاب اتباع مدونة السلوك الخاصة بنا لضمان أن تكون أدلتنا مقبولة للجميع بغض النظر عن العمر أو العرق أو الهوية الجنسية أو مستوى الخبرة أو الجنسية أو الدين أو الانتماء السياسي أو التوجه الجنسي أو الوضع الاجتماعي الاقتصادي أو اختيارات التكنولوجيا. يجب تجنب أي لغة قد تكون مسيئة أو أي محتوى يشير إلى المواضيع المذكورة أعلاه.
التنسيق
يتم تنسيق توثيقنا باستخدام لغة Markdown التي تُستخدم على نطاق واسع وبسيطة نسبيًا. اطلع على الأقسام أدناه لفهم ما نستخدمه وكيف نستخدمه.
لمزيد من الأمثلة والتفسيرات الموسعة لميزات Markdown، توجه إلى دليل Markdown الذي يوفر معلومات إضافية.
العناوين
العناوين هي واحدة من أهم خيارات التنسيق المستخدمة لفصل الصفحات بشكل شامل ومنطقي. العنوان الرئيسي يتكون من H1، لكن لا يجب عليك استخدامه داخل النص. بدلاً من ذلك، يجب استخدام بيانات التعريف title
في أعلى ملف الدليل التي تتحكم في ذلك.
في أدلتنا، يجب استخدام عناوين 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/[your_name]/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 مفيدة جدًا أخرى هي كتل الكود. تكون مفيدة بشكل خاص للأدلة التي تتضمن استخدام أوامر، سكربتات، مخرجات الطرفية والمزيد.
لاستخدام كتلة كود، ببساطة استخدم ```
خارج النص الذي تريد وضعه في كتلة. يمكنك أيضًا تحديد اللغة بجانب أول ثلاث علامات backquote لتنسيق لغة البرمجة بشكل صحيح. مثال على استخدام كتلة كود بلغة JavaScript:
function hello(name) {
console.log(name)
}
var server = "ZAP-Hosting"
hello(server)
استخدام التنبيهات
داخل المحتوى، قد تقرر استخدام تنبيه لتسليط الضوء على معلومات معينة تحت أحد الأنواع الخمسة الممكنة، والتي نستعرضها أدناه.
الصيغة لاستخدام كل تنبيه هي نفسها، مع استبدال الكلمة المفتاحية بالنوع الذي تريد استخدامه. مثال على الاستخدام:
:::note
هذه ملاحظة! استبدل الكلمة المفتاحية أعلاه لتغيير النوع.
:::
ملاحظة
يجب استخدام هذا الوسم لعرض ملاحظات إضافية قد تكون مفيدة لكنها ليست مهمة مباشرة.
نصيحة
ضع أي نصائح لديك من خبرتك في هذا الوسم.
معلومات
إذا كانت هناك معلومات مهمة يجب أن يعرفها المستخدم، ضعها ضمن هذا الوسم.
تحذير
هل هناك شيء في دليلك يجب أن يحذر المستخدم منه أثناء المتابعة؟ استخدم هذا الوسم لتسليط الضوء عليه.
خطر
يجب استخدام تنبيه الخطر حيثما تحتاج إلى تسليط الضوء على معلومات حاسمة. خصوصًا لجعل المستخدم على علم بأخطاء معروفة أو ميزات مهجورة.
لقطات الشاشة
لقطات الشاشة طريقة مفيدة جدًا لإرشاد القراء بصريًا خلال الخطوات وننصح باستخدامها حيثما كان ذلك مناسبًا.
لتلبية القسم الألماني، عند التقاط لقطة شاشة، نتوقع منك إضافة نسخة بالإنجليزية ونسخة بالألمانية لضمان اتساق لقطات الشاشة. داخل دليلك، يمكنك وضعهما جنبًا إلى جنب. سيتم إزالة لقطات الشاشة الألمانية واستخدامها بمجرد أن يقوم فريق ZAP-Docs بترجمة مقالك.
يمكنك استخدام الصيغة التالية لإضافة لقطة شاشة إلى المحتوى، مع استبدال your_url
برابط الصورة:

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