تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- Creative Commons
- الكاتب التقني:
- JackieBinya
- اسم المشروع:
- دليل استخدام المظهر الأساسي في WordPress
- مدة المشروع:
- مدة زمنية عادية (3 أشهر)
وصف المشروع
خلال مرحلة تقديم طلب الكاتب التقني في فعالية GSOD-2020، أجريتُ العديد من التفاعلات مع "هوغو سولار"، وهو مرشد مشروع توثيق المظاهر الأساسية في WordPress.
في تواصلي الأول معه، طلبتُ المساعدة في فهم أهداف إنشاء دليل استخدام المظهر الأساسي في WordPress، وكان مفيدًا جدًا وساعدني بسرعة في الانضمام إلى المشروع. بعد ذلك، كانت جميع التفاعلات المتتالية التي أجريناها تدور حول تحسين أهداف مستندات المظهر الأساسي لواجهة CC WordPress.
عندما وصلت إلى مرحلة شعرت فيها أنّني فهمت متطلبات المشروع وأهدافه، انتقلت إلى إنشاء مسودة اقتراح لدليل استخدام المظهر الأساسي لخدمة CC WordPress.
تم إنشاء هذا الاقتراح باستخدام النموذج الرسمي من Creative Commons لطلبات التدريب. فهو يوفّر معلومات حول ملخّص المشروع وبنية المشروع المقترَحة وتخطيط مستندات المظهر الأساسي الجديد في WordPress بالإضافة إلى معلومات حول المخططات الزمنية والمُخرَجات النهائية لمرحلة إنشاء المستند.
بعد ذلك، راجع "هوغو سولار" مسودة الاقتراح وقدّم لي ملاحظات لإجراء تحسينات. وخلال هذه العملية، كان متوفرًا دائمًا للإجابة عن الأسئلة حول المشروع.
لقد نفّذتُ الملاحظات المقدَّمة، ويمكنك الاطّلاع على اقتراحنا النهائي لإنشاء مستندات شارات المساواة بين الجنسين في الرابط أدناه على شكل مستند Google.
https://docs.google.com/document/d/1XmIsMTLstbhRRSaNFP538YOXJiS0G5QrN6EzuqJfRy4/edit?usp=sharing
في ما يلي ملخّص موجز لاقتراحي:
Creative Commons - WordPress base theme usage guide A proposal prepared by Jacqueline Binya, 28 June 2020
ملخّص المشروع الهدف النهائي من هذا المشروع هو إنشاء مستندات موجّهة للمنتدى غنية وسهلة الاستخدام وجذابة ومُقدَّمة بشكل جميل لموضوع WordPress الأساسي في Creative Commons.
خطة المشروع المشكلة لا يتوفّر حاليًا مستندات حول مظهر Creative Commons WordPress Base، ما يشكّل عائقًا أمام الاستخدام الفعّال للمظهر في المنتدى. هدفي هو إنشاء دليل استخدام كامل للمظهر وتنفيذ عمليات التجريد أيضًا في قاعدة البيانات الحالية لمظهر WP Base لتسهيل استخدام المظهر.
الحل يمكنك إنشاء مستندات مستقبلية باستخدام أطر عمل حديثة مثل Gatsby. يحتوي Gatsby على برامج بدء يمكننا استخدامها لبدء تشغيل مستندات WordPress Base Theme الجديدة. ومن الأمثلة على حِزم البدء حزمة gatsby-gitbook-starter التي تأتي مزوّدة بشكل تلقائي بميزات تحسين محركات البحث وMarkdown وAlgolia (وهي أداة تُستخدَم لدمج ميزة البحث في المواقع الإلكترونية الثابتة). بالإضافة إلى ذلك، يمكن تحسين أي موقع إلكتروني تم إنشاؤه باستخدام Gatsby بسهولة لدمج ميزتَي الترجمة والوصول السهل. عند إنشاء المستندات، أسعى إلى جعلها سهلة الاستخدام قدر الإمكان من خلال: - كتابة المستندات بطريقة سهلة الفهم مع الحرص على تجنُّب الغموض واستخدام المصطلحات التقنية المعقدة بشكل مفرط. - من خلال دمج الرسوم التوضيحية والوسائط في الوثائق لاستخدامها كوسائل مساعدة مرئية للتعلّم. - استخدام أمثلة توضّح كيفية تنفيذ المهام الشائعة، مثل عمليات التخصيص
تشمل العناصر المجردة التي أتمنّى تنفيذها ضمان أنّه يمكن للمستخدمين الاستفادة من معظم الوظائف الأساسية لواجهة WP Base، مثل العناصر المرسِلة، من خلال لوحة المشرف في WordPress. بالإضافة إلى ذلك، أريد إنشاء مظهر ثانوي أوّلي للمظهر الأساسي WP في مستودع منفصل. سيوفّر توفُّر مظهر فرعي أساسي تجربة إعداد أسهل وأسرع للمستخدمين الجدد. بعد اكتمال المستندات والموافقة عليها، سيتم نشرها واستضافتها على الإنترنت.
البنية المقترَحة لدليل استخدام المظهر الأساسي لخدمة CC WordPress - سيتم تقسيم المستندات المقترَحة إلى أقسام مختلفة مُدرَجة أدناه. بعد ذلك، تقدّم عناصر القائمة الفرعية ضمن كل قسم مقترَح مزيدًا من التفاصيل حول المحتوى الفعلي الذي سيتم العثور عليه في الأقسام ذات الصلة.
قسم النظرة العامة - حدِّد التعريف والأهداف والميزات الأساسية لمظهر WordPress الأساسي من Creative Commons. * التعريف: يُرجى وصف المظهر الأساسي بتنسيق CC WP بإيجاز. * الأهداف: حدِّد الأهداف/ المقصود من مظهر CC WP Base Theme * الميزات: حدِّد ميزات مظهر CC WP Base Theme
قسم "البدء" - المتطلبات * يُرجى توضيح متطلبات تثبيت المظهر الأساسي لخدمة WordPress في CC، مثل: - إصدار WordPress - إصدار PHP - Composer وما إلى ذلك. - دليل التثبيت * يُرجى توضيح كيفية استخدام المستخدمين لملف zip لتثبيت مظهر WordPress في CC * يُرجى توضيح كيفية بدء المستخدمين من خلال استنساخ المظهر الأساسي لخدمة WordPress من GitHub. * حدِّد كيفية تثبيت المستخدمين للتبعيات في المشروع. * يُرجى شرح كيفية ضبط المستخدمين لمتطلبات Queulat. * شرح كيفية تفعيل المظهر في بيئة تطوير WordPress المحلية
دليل الاستخدام - نظرة عامة * شرح مصطلح "موضوع الأطفال" * توضيح مزايا استخدام موضوع مخصّص للأطفال * يُرجى إبلاغ المستخدمين بأنّ الطريقة المُقترَحة لتعديل مظهر WP Base هي من خلال مظهر فرعي. * يجب التأكيد على أنّه يجب تثبيت "مظهر WP الأساسي" وتفعيله قبل أن يتمكّن المستخدمون من إنشاء مظهر فرعي.
استخدام مظهر فرعي - شرح كيفية إنشاء المستخدمين لمظهر فرعي من مظهر WP Base باستخدام مظهر أساسي استخدِم فيديو لشرح كيفية إنشاء موضوع فرعي من الموضوع الأساسي.
التخصيص في الأقسام الفرعية المُدرَجة أدناه، نوضّح كيفية استخدام المستخدمين لأداة تخصيص WordPress ولوحة مشرفي WordPress لإجراء عمليات تخصيص. سندمج أيضًا استخدام الرسوم التوضيحية لجعل الأوصاف أكثر سهولة. - تخصيص وصف الموقع أو سطر الوصف. - قوائم التنقّل المخصّصة - تخصيص CSS - إضافة صفحات - إضافة مشاركات - التطبيقات المصغّرة - إضافة التطبيقات المصغّرة وإزالتها من لوحة إدارة WordPress - إضافة التطبيقات المصغّرة باستخدام أداة "المخصّص" مع معاينة مباشرة
قسم "التخصيصات المتقدّمة" - قسم "تخصيص CSS" * يُرجى وصف المكوّنات التي تشكّل تصميم المظهر: - مفردات CC - Bulma - Sass * يُرجى شرح كيفية إعداد Sass في المشروع. يجب أن يتضمّن الشرح معلومات عن: (1) موقع ملفات sass في بنية المشروع (2) نصوص npm البرمجية التي يمكن استخدامها لإنشاء sass ومشاهدته * شرح كيفية تخصيص المستخدمين لأنماط sass في المظهر الفرعي، أي من خلال تثبيت تبعيات npm محدّدة * شرح كيفية استخدام فئة المكوّن (class-component.php) لتخصيص أنماط مكوّنات معيّنة
- قسم الخطاطيف
نظرة عامة
- شرح مصطلح "الزوابع"
- اشرح سبب احتياج المستخدمين إلى الاستفادة من عناصر الجذب.
- حدِّد الخطوط العريضة لأنواع عناصر الجذب المتاحة.
استخدام "الإجراءات"
- إدراج الإجراءات المتاحة في مظهر WP Base وموقعها
- اشرح كيفية تنفيذ هذه الإجراءات.
*استخدام الفلاتر - إدراج الفلاتر المتاحة في الموضوع وشرح كيفية تنفيذها
قسم تعديل المظهر - توضِّح كيفية تعديل المستخدمين للمظهر.
قسم الترخيص * يُرجى شرح ترخيص المشروع وتأثيره في المستخدمين الذين قد يريدون استخدام المظهر الأساسي لموقع WordPress في مشاريعهم الشخصية.
قسم المساهمة * إضافة دليل مفصل عن المساهمة * توضيح قواعد السلوك * المنتدى: توفير معلومات حول قنوات منتدى Creative Commons وكيفية مشاركة المساهمين وما إلى ذلك.