تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- WordPress
- الكاتب الفني:
- tacitonic
- اسم المشروع:
- مجموعة كاملة ومجدّدة من دليل الإرشادات حول أسلوب كتابة المستندات
- مدة المشروع:
- الحمل لمدة طويلة (5 أشهر)
وصف المشروع
الملخص:
WordPress هي مؤسسة عالمية غير ربحية تعمل في مجال البرامج، وهي مخصّصة لخدمة المجتمعات العالمية من خلال توفير برامج تركّز على سهولة الاستخدام والأداء والأمان وإمكانية الوصول. تسعى WordPress جاهدة إلى إتاحة نشر المحتوى والبرامج مفتوحة المصدر على الويب للجميع. في عصرنا الرقمي، يمثّل الموقع الإلكتروني الواجهة على الإنترنت للمؤسسات أو الأفراد، ويؤدي WordPress مهمة ضخمة تتمثل في خدمة مئات الملايين من المستخدمين بكفاءة، وذلك لأنّه يشغّل% 35 من الإنترنت. لتقديم خدمة أكثر فعالية لهؤلاء المستخدمين، تبيّن أنّ المستندات ضرورية ويستخدمها معظم المطوّرين والمشرفين والمستخدمين النهائيين. وبالتالي، يمكن اعتبار التوثيق عاملاً أساسيًا لمنظومة WordPress المتكاملة. لا تتضمّن مستندات WordPress الحالية مجموعة عالمية وموحدة من القواعد وإرشادات الأنماط للنشر. إنّ الدافع وراء هذا الاقتراح هو إنشاء مجموعة كاملة ومجدّدة من إرشادات نمط التوثيق التي يمكن تطبيقها عالميًا على مستندات WordPress. تتضمن فكرة المشروع توحيد جميع جوانب إرشادات التصميم والأسلوب مثل الدلالة والنحوية والإرشادات النحوية وعلامات الترقيم والقواعد الخاصة بالتطوير وسمات التصميم وتفاصيل التنسيق. ويشمل أيضًا اصطلاحات اللغة، مثل الصوت والأسلوب ودرجة التذكير أو التأنيث وجميع أجزاء الكلام، بالإضافة إلى اصطلاحات التسمية. ستكون الأدوات واللغات والمنصات المستخدَمة هي WordPress CMS وGitHub وMarkdown، وقد تتضمّن أيضًا PHP/MySQL وHTML/CSS وجافا سكريبت.
خطة المشروع:
الحالة الحالية لأدلّة أسلوب صياغة مستندات WordPress: كان فريق مستندات WordPress ينفّذ منهجية غير معلَن عنها ولكنّها موحّدة لنشر الإرشادات. ولكن من حين لآخر، يتم افتراض بعض العناصر وتصبح العملية تخمينية. لا يتوفّر أي معيار ومعايير ثابتة بغرض كتابة المقالات ونشرها على WordPress. وضع فريق إعداد الوثائق إرشادات أسلوب خاصة بالمشروع، ولكن لا تتوفّر إرشادات أسلوب تنطبق بشكل عام. لا يتم تجميع معظم إرشادات الأسلوب الحالية في دليل واحد، أو يتم إيقافها نهائيًا ويجب تحديثها. وبالتالي، هناك حاجة إلى تصميم وتطوير دليل أسلوب موحّد لتوحيد مستندات WordPress.
الأهداف:
يعمل أكثر من% 35 من المواقع الإلكترونية على الإنترنت باستخدام WordPress، ما يشير بدوره إلى أنّ ملايين المطوّرين والمستخدِمين النهائيين يستخدمون وظائف WordPress الرائعة. يُعتبر التوثيق عنصرًا أساسيًا في مساعدة هؤلاء المطوّرين والمستخدمين على تنفيذ هذه الوظائف بفعالية وبدون أي مشاكل، حتى في حال حدوث أي إزعاج. يتمثل الهدف العام من اقتراح المشروع هذا في توحيد دليل التصميم والأسلوب، وتوحيد أدلة الأسلوب الحالية وتعديلها، بالإضافة إلى إلحاق اللوائح والمواصفات الجديدة بمستندات WordPress. سيؤدي ذلك إلى تسهيل الاستخدام والبساطة والتوحيد في مستندات WordPress.
التنفيذ:
وفقًا لما اقترحه المرشد (جون أنج) لهذا المشروع، يمكن معالجة المشروع في 4 مراحل: مرحلة الاستكشاف والتعريف والتنفيذ والصيانة. قبل بدء المشروع، وخلال فترة ما قبل التدريب، سأعمل مع المرشد وأُكمِل الجدول الزمني المناسب وفقًا للجدول الزمني والإنجازات اللاحقة. سأتعرّف أكثر على نظام WordPress وبروتوكولات العمل لهذا المشروع.
مع بدء فترة التدريب، سأناقش ملخّص الخطة مع المرشد وسأعدّ مسودته. سيتم تحديد المتطلبات والضروريات. أولاً، سأوضّح مسار المستندات وعملية تفاعل المستخدم. بعد ذلك، سيتم تحديد إطارات العمل للتخطيط لكل قسم وفئة ومكوّن. بعد ذلك، سيراجع المرشد هذه التنسيقات. إذا لزم الأمر، ستتم إعادة تصميم التنسيقات وإضافة/إزالة بعض المكونات. سأُجري بعد ذلك أبحاثًا حول المستخدمين لتحديد قابلية الاستخدام ومدى جدوى مسار الواجهة. بعد ذلك، سيتم تنفيذ دليل أسلوب المستندات (كما هو موضّح في المخطّط البياني أدناه) لكل قسم. يمكن أيضًا الإشارة إلى أدلة الأنماط من المؤسسات الأخرى التي تخضع لأي تراخيص مفتوحة المصدر أو تراخيص المشاع الإبداعي لإرفاقها بدليلنا. إذا واجهت أي صعوبات في قابلية الاستخدام خلال هذه الفترة، سأعيد تصميمها.
سيتم إجراء الاختبارات والتحسينات بعد اكتمال دليل الأنماط ودمجه مع HelpHub. سيتم تصحيح أي ثغرات أو عناصر أو مكوّنات زائدة. سيتم إجراء اختبار واجهة المستخدم والرمز البرمجي وإصلاح الأخطاء غير المرغوب فيها، إذا لزم الأمر. سيتم إجراء مراقبة جودة نهائية لدليل الأسلوب الكامل في ما يتعلق باللغة والقواعد النحوية والإملائية وعلامات الترقيم وما إلى ذلك.
سيتم إكمال المهام التي تكون في انتظار المراجعة بسبب تأخيرات غير متوقّعة خلال الفترة الزمنية التي تفصل بين الإصدارات. يمكن تنفيذ وظائف أو ميزات إضافية يتم تحديد إمكانية تنفيذها خلال مسار المشروع بعد الانتهاء من الاختبار النهائي. سيتم إنشاء خطة نشر وإرسال المنتج النهائي.
الأدوات والمنهجيات:
سيتم تجميع المستندات وتعديلها على منصة تعاونية، مثل "مستندات Google". إذا كان مطلوبًا نشر المحتوى من خلال GitHub، يمكن أيضًا استخدام لغات الترميز مثل Markdown أو GitHub Flavored Markdown. بالنسبة إلى معايير التصميم والأنماط، يمكن أيضًا الرجوع إلى إرشادات الأنماط المتاحة للاستخدام المفتوح. أخيرًا، سيتم تنسيق المستند المكتمل ونشره باستخدام WordPress.
جدول المكوّنات:
هذه قائمة شاملة بالمكوّنات التي يمكن تنفيذها في دليل الأنماط. إرشادات المستندات: تسهيل الاستخدام، وبنية المستند، والترميز، والمصادر الخارجية، والحقائق، والخطوط، والجمهور العالمي، والشمولية، والشرعية، وتسهيل الاستخدام على منصات متعددة، وعدم الغموض، وعدم تضمين ادعاءات مفرطة، وتنسيق الصفحة، واللغة السياسية الصحيحة، والبروتوكولات، والأمان، وبنية الجملة، والكتابة الموجزة، والأسلوب، وعدم الانحياز
اللغة والقواعد النحوية: الاختصارات والاختصارات المختصرة، التأكيد والسلب، الضمائر، الأحرف الكبيرة، الجُمل، الكلام المباشر/غير المباشر، الشخص الأول/الثاني/الثالث، الأنواع، المسرد، الأسماء، البادئات واللاحقات، الظرائف، الضمائر، الإشارة، اللغة العامية والمصطلحات، الإملاء، المصطلحات الفنية، الأزمنة، الأفعال، الأصوات
علامات الترقيم: علامة الاقتباس والفاصلة العليا، والقوسين والفاصلة المنقوطة، والفواصل، والنقاط المنقوطة، وعلامات التعجب، والشرطات السفلية والعادية، والقوسين، والنقاط، وعلامات الاستفهام، والشرطات
التنسيق - الملخصات، المقدّمات، المقاطع التمهيدية، أسماء العلامات التجارية، أسماء المنتجات، الترجمة، مقتطفات الرموز البرمجية، أقسام الرموز البرمجية، التاريخ والوقت، المناطق الزمنية، الأماكن، العملات، أسماء الملفات، الحواشي السفلية، العناوين، التمييز (الخطّ الغامق، والخطّ المائل، والخطّ تحته خط، والخطّ المشطوب، والاقتباس)، المسافة البادئة، الفهرس، الروابط وعناوين URL، القوائم، النقاط النقطية، الترقيم، الوسائط (الصور والفيديوهات) والرسوم التوضيحية، الملاحظات، التحذيرات، النصائح، الأرقام وأرقام الهواتف، الترجمات المتعددة اللغات، الترجمة، نصوص اللغات، المسافات، الجداول، النصوص، العلامات التجارية، حقوق الطبع والنشر، براءات الاختراع، الإحالات، الأدلة الإرشادية والإجراءات، عناصر واجهة المستخدم، وحدات القياس
واجهة المستخدم: الأنشطة والأزرار ومقتطفات الرموز البرمجية ووحدات الرموز البرمجية وواجهة سطر الأوامر والمحادثات والقوائم والقوائم المنسدلة والنوافذ المنبثقة والتنبيهات وعلامات التبويب والمصطلحات وعناصر واجهة المستخدم والنوافذ
الرموز البرمجية: CSS وHTML وJS وMarkdown وMySQL وPHP وSyntax وXML
قاموس/مسرد استخدام الكلمات - من الألف إلى الياء