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