مشروع مؤسسة Wikimedia

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".

ملخص المشروع

مؤسسة مفتوحة المصدر:
مؤسسة Wikimedia
الكاتب الفني:
بافيثرا إسواراموثي
اسم المشروع:
تحسين المستندات المتعلّقة بمصوّري المستندات الفنية ومصوّري الفيديو على Wikimedia
مدة المشروع:
مدة زمنية عادية (3 أشهر)

وصف المشروع

1. لمحة عني

لقد تعرّفتُ على البرامج المفتوحة المصدر قبل بضعة أشهر، وشعرتُ على الفور تقريبًا بالارتباك بسبب نطاقها غير المحدود. بعد أن واجهتُ صعوبة في طريقي إلى مشاريع البازيليون، اطّلعت على مبادرات البرامج المفتوحة المصدر مثل Google Summer of Code وOutreachy. بدا لي موسم "مستندات Google" مثيرًا للاهتمام، ولفتت أفكار المشاريع التي طرحتها مؤسسة Wikimedia انتباهي، لذلك بدأت في استكشاف المزيد من المعلومات.

كانت رحلتي حتى الآن مليئة بالمشاعر المثيرة والمربكة، ومليئة بالتساؤلات مثل "لحظة، ماذا؟" و"آه، فهمت" و"هل عليّ التعليق على هذا؟". وقد كان منتدى Wikimedia داعمًا لي في كل خطوة. من تعديل الصفحات إلى إنشاء الإضافات، تعلّمت شيئًا جديدًا كل يوم.

كما هو متوقّع، كانت عملية تقديم الطلب بمثابة بوابة لي إلى منتدى البرامج مفتوحة المصدر. استوحيت هذا الاقتراح من تجاربي الشخصية عندما كنت مبتدئًا.

2. المشروع

2.1. المخطَّط

يهدف هذا المشروع إلى تحسين التوثيق للكتّاب التقنيين ومصوّري الفيديو المحتملين عبر ويكيميديا. ستساعد مجموعة كاملة من إرشادات الوثائق الفنية في تعزيز التوثيق الشامل الذي تم تحسينه، كما ستتيح مراجع إنشاء تسجيلات رقمية للشاشة إمكانية عرض ميزات البرنامج بفعالية. يمكن توسيع نطاق المستندات الحالية في هذه المجالات لتقديم دعم أفضل لكلّ من المساهمين الجدد وذوي الخبرة. وسيتم اعتماد نهج تدريجي لتطوير هذه الشبكة من الموارد المفيدة.

2.2. مواد العرض

  • ‫T197006 [https://phabricator.wikimedia.org/T197006] - تحسين المستندات لصنّاع الوثائق في Wikimedia:

    • أضف نصائح وأمثلة إلى التوثيق/دليل الأسلوب. [https://www.mediawiki.org/wiki/Documentation/Style_guide]
    • أضف معلومات خاصة بـ MediaWiki إلى أنواع معينة في نماذج واقتراحات التوثيق الفني: أدلة المستخدم، وإرشادات، وأدلة البدء السريع، وملاحظات الإصدار، وملفات README. [https://www.mediawiki.org/wiki/Technical_documentation_templates_and_suggestions]
    • اختبار إرشادات تحديد الأولويات للمستندات الفنية وتحسينها [https://www.mediawiki.org/wiki/Technical_documentation_prioritization]
    • تصميم استراتيجية لجمع المحتوى لأنواع مختلفة من الوثائق
    • تصميم استراتيجية للتواصل والتعاون في ما يتعلّق بمستندات MediaWiki
    • أنشِئ قائمة تحقُّق يمكن للكتّاب مراجعة مستنداتهم وفقًا لها قبل نشرها.
    • توسيع بنية المستندات لتشمل الكتاب التقنيين الجدد [https://www.mediawiki.org/wiki/User:Pavithraes/Sandbox/New_Technical_Writers]
    • أنشئ قائمة بمهام إعداد المستندات الفنية المناسبة للمشاركة في ورشة عمل برمجية. [https://www.mediawiki.org/wiki/Technical_Documentation_Tasks_for_Hack-a-thons]
    • أنشئ مركزًا للمحرِّرين الفنيين يشير إلى موارد مفيدة.

  • تحسين المستندات لصنّاع الفيديوهات في MediaWiki:

    • أنشئ دليلاً سريعًا للمستخدمين لإنشاء تسجيل رقمي عام للشاشة.
    • تصميم نماذج لتسجيلات الشاشة خاصة بخدمة MediaWiki لإنشاء الجولات الإرشادية والأدلة التعليمية

  • ‫T214522 [https://phabricator.wikimedia.org/T214522]- إنشاء تسجيل رقمي للشاشة بعنوان "مقدّمة عن Phabricator"

2.3. هدف قابل للتوسيع

  • يُرجى إعادة التحقّق من المحتوى وتعديل مستندات WikiProject Screencast. (https://en.wikipedia.org/wiki/Wikipedia:WikiProject_Screencast)

3- المرشدون

سيكون تطبيق Zulip هو الطريقة الأساسية للتواصل مع المرشدين. سيتم استخدام قنوات IRC وبريد Wikimedia الإلكتروني لإجراء مناقشات مع المنتدى. ستحدث مناقشات حول مهام محددة في قسم التعليقات لمهام PHabricator.

4. مناقشة

ينقسم هذا المشروع بشكل عام إلى مرحلتين:

(ط) تحسين الموارد الحالية للكتّاب التقنيين في Wikimedia.

(2) إنشاء نماذج مفيدة لصنّاع الفيديو المحتملين

(1) تحسين المراجع الحالية لكتاب المحتوى الفني في Wikimedia

في السابق، تم إطلاق العديد من المبادرات لتحسين مستندات MediaWiki بدرجات متفاوتة من النجاح. على سبيل المثال لا الحصر:

  • https://www.mediawiki.org/wiki/User:Zakgreant/Tech_DocsPlan(2011--01/P6M)
  • https://www.mediawiki.org/wiki/User:Zakgreant/MediaWiki_Technical_Documentation_Plan
  • https://www.mediawiki.org/wiki/Thread:Project:Current_issues/RestructureMediaWiki.org(or:_Document_how_it_was_and_execute_it)
  • https://www.mediawiki.org/wiki/User:Waldir/Docs

من خلال هذه الجهود، يمكننا أن نفهم أنّ توفُّر مجموعة أفضل من المراجع للمؤلفين الفنيين سيكون له تأثير مباشر في المستندات التي ينشئونها.

في ما يلي مقتطف من التقرير الذي يُنجز كل أسبوعين حول متدرّبة في برنامج التواصل مع فريق التواصل لعام 2018، "آنا" https://anna.flourishing.stream/2018/01/18/bringing-documentation-to-light/:

"دليل أسلوب MediaWiki بعيد كل البعد عن الكمال، لا سيما أنّه يعتمد بشكل كبير على المراجع الخارجية بدون إبراز الممارسات التي يعتبرها الأفضل. هذه المشكلة لا تقتصر على MediaWiki فقط، بل تظهر أيضًا في مستندات أخرى، مثل أفضل الممارسات المتعلقة بالترجمة. في النهاية، لا يتوفّر للكتاب مصادر جيدة وموثوقة لتنفيذ أعمالهم، ما يؤدي إلى صعوبة تحديد جمهور مستهدف وأسلوب كتابة مناسب. وقد يواجه المستخدمون، خاصةً المستخدمون الجدد، مشاكل في فهم المفاهيم والعمليات الجديدة".

يسلط الطلب T197006 [https://phabricator.wikimedia.org/T197006] الضوء أيضًا على مجالات معيّنة من مستندات الكتابة الفنية التي تحتاج إلى تحسين. من الواضح أنّ Documentation/Style_guide هو المكان المناسب للبدء.

بعد أن نحصل على دليل أسلوب أفضل، سيتم التخطيط لمجموعة المستندات التالية لإرشاد الكتاب الفنيين خلال المراحل المختلفة من الكتابة الفنية. يجب أن تكون المستندات سهلة الاستخدام للمبتدئين وفي الوقت نفسه أن تقدّم كل المعلومات اللازمة ليرجع إليها الكتاب.

ربما تكون مرحلة التحضير هي الأكثر أهمية لأنّها تضع الأساس الذي بني عليه المستند. ولدعم المؤلفين التقنيين خلال هذه المرحلة، تم تطوير مستندات مرجعية تصف بعض الطرق الفعالة لجمع المعلومات والنصائح ذات الصلة حول تنظيم هذه المعلومات باستخدام النماذج.

ثم تأتي مرحلة الكتابة. يتم تزويد الكتاب بأمثلة على الأعمال الجيدة لرفع مستوى الأداء تلقائيًا. بالإضافة إلى ذلك، يتم إنشاء قائمة تحقّق تتضمّن مجموعة من المعايير الأساسية التي يجب أن يستوفيها كل مستند، ما يساعد الكتاب في مراجعة مستنداتهم قبل نشرها.

حتى مع توفّر هذه المستندات، سيحتاج الكتاب الفنيون الجدد إلى مساعدة إضافية، وعلينا تقديمها لهم. تم تحسين دليل الكتاب التقنيين الجدد، وتم اختيار قائمة بالمهام المناسبة للهاكثون استنادًا إلى مستوى الصعوبة.

وأخيرًا، تم اختبار مستند لفهم عملية إدارة التوثيق والحفاظ عليه - تم اختبار وتحسين "تحديد أولويات المستندات الفنية".

في نهاية هذه المرحلة، سيتم إنشاء مركز لأدلة الكتابة الفنية والموارد والأمثلة والاقتراحات والقوالب لدعم دليل أسلوب التوثيق.

(2) أنشئ نماذج مفيدة لمصوري الفيديو المحتملين.

"من أصعب الطرق لتعلم أي شيء يتضمّن رسومات هي قراءة نص عادي. تخيل أيضًا ما يحدث إذا كان الدليل الخاص بك يشير إلى إصدار خاطئ من البرنامج - فمع الكتيبات النصية فقط يصبح من المستحيل غالبًا إعادة إنشاء سلسلة من الإجراءات عندما تتغير القوائم والصياغة في التطبيق نظرًا لأننا نفتقر إلى جميع الإشارات التي نستخدمها عادةً.

إنّ أفضل طريقة للتعلم هي عندما يجلس خبير بجانبك. تقع لقطات الشاشة بين الرسومات الثابتة والحصول على دعم من خبير قريب. نحصل على عرض توضيحي مرئي متحرك بصوت ودي، ويمكننا أيضًا الحصول على تعليقات توضيحية نصية على الشاشة وصور متحركة. من مزايا تسجيلات الشاشة مقارنةً بالخبراء أنّه يمكن إعادة تشغيلها متى شئت كل ساعة من كل يوم.

يمكننا أيضًا إضافة ترجمة إلى التسجيل الرقمي للشاشة ليتمكّن المتحدّثون الذين لا يتحدثون اللغة الأم من مشاهدتها، أو يمكن استبدال المقطع الصوتي بلغات بديلة."

في المقتطف أعلاه من "دليل تسجيل الشاشة" [https://thescreencastinghandbook.com/wp-content/uploads/The_Screencasting_Handbook_rel10_20100502_v6.pdf]، يوضّح"إيان أوزوالد" أهمية تسجيلات الشاشة. وقد يكون مفيدًا بشكل خاص لدروس حول إعداد بيئة تطوير MediaWiki وكتابة الإضافات واستخدام Gerrit وغير ذلك.

تمامًا مثل النماذج الخاصة بالمستندات، يؤدي استخدام نموذج عادي لتسجيلات الشاشة إلى تعزيز التناسق، ما يؤدي بدوره إلى تحسين تجربة المشاهد. كما يوفّر هذا الإطار لصنّاع الفيديو المحتملين قاعدة أساسية للبدء. وبالتالي، تم تطوير دليل سريع للمستخدمين متبوعًا بنماذج لإنشاء فيديوهات تمهيدية ودروس تعليمية. تتضمن المستندات مؤشرات حول عمق المفاهيم التي سيتم تناولها وبعض أفكار التسجيل الرقمي للشاشة من أجل MediaWiki.

إنّ أفضل طريقة لاختبار النموذج أعلاه والاستعداد لتحقيق الهدف الإضافي هي إنشاء تسجيل شاشة باستخدام الأدوات والنماذج. وبالتالي، تم إنشاء تسجيل شاشة بعنوان "مقدّمة عن Phabricator" يتناول أساسيات استخدام Phabricator. وستسلّط هذه العملية الضوء أيضًا على الجوانب التي تستدعي المناقشة.

أخيرًا، تمت مراجعة وتعديل مصدر المعلومات المركزي لصنّاع الفيديو في Wikimedia، وهو WikiProject Screencast.

5- المخطط الزمني الأولي

فترة التفاعل مع المنتدى (من 1 آب (أغسطس) إلى 1 أيلول (سبتمبر))

  • تحليل المشروع بالتفصيل مع المرشدين

  • مناقشة حول:

    • وتيرة مراجعة المهام
    • شارِك الجداول الزمنية وحدِّد سير العمل الأسبوعي أو اليومي.
    • الأدوات والموارد التي يمكن استخدامها.
    • تقارير المشاريع الأسبوعية واليومية

  • أنشئ المهام والمهام الفرعية المطلوبة على Phabricator.

  • إنشاء مسودات للتعويض عن الالتزامات الشخصية أثناء مرحلة تطوير المستند.

الأسبوع 1 (من 2 إلى 8 أيلول/سبتمبر)

  • تحسين التوثيق/دليل_الأسلوب:

    • غيِّر التركيز الأساسي لتوضيح أفضل الممارسات والمعايير على MediaWiki.
    • يمكنك تضمين أمثلة على الأعمال الجيدة وتحسين مستوى ظهور الصفحات المرتبطة.

  • تحسين الدليل المخصّص للمحرِّرين الفنيين الجدد:

    • توسيع بنية المستندات

الأسبوع 2 (من 9 إلى 15 أيلول (سبتمبر))

  • العمل على تحديد أولويات المستندات الفنية:

    • تقييم لوحة عمل المستندات والعثور على أمثلة لوصف المهام وتحديد أولوياتها بشكل جيد
    • راقِب المؤشرات ودوِّن الصعوبات الشائعة.
    • استخدِم المعلومات والأمثلة لتوثيق معايير تحديد الأولويات.

الأسبوع 3 (من 16 إلى 22 سبتمبر)

  • أنشئ المستندات الإضافية التالية للمحررين الفنيين:

    • قائمة تحقّق للمساعدة في مراجعة المستندات الفنية قبل نشرها
    • طرق جمع المحتوى بفعالية لأنواع مختلفة من الوثائق

الأسبوع 4 (من 23 إلى 29 أيلول/سبتمبر)

  • أضف معلومات حول الكتابة في أنواع MediaWiki الأكثر شيوعًا إلى نماذج واقتراحات المستندات الفنية:

    • سجِّل أفضل الممارسات في MediaWiki لكتابة أدلة المستخدمين وأدلة البدء السريع وملفات README وملاحظات الإصدار والأدلة الإرشادية.

  • أضِف إرشادات لتحسين مستوى النضج في التواصل الفني. [https://www.mediawiki.org/wiki/User:SRodlund_(WMF)/Maturity_model_for_MediaWiki_technical_documentation#Increasingmaturity--_strategic_directions]

الأسبوع 5 (30 سبتمبر - 6 أكتوبر)

  • تحسين المستندات الخاصة بإعداد المتعاونين الجدد:

    • تعديل الصفحة: مهام المستندات الفنية لأحداث الهackathon (مهام مُراد تنفيذها: إضافة مهام مناسبة إلى هذه الصفحة خلال فترة المشروع)

  • إنشاء مركز للكتّاب التقني

    • أنشئ صفحة مقصودة تتضمّن روابط تؤدي إلى صفحات وموارد مفيدة.
    • أضِف الروابط الضرورية إلى الصفحات الجديدة والحالية لتسهيل التنقّل بينها.

الأسبوع 6 (من 7 إلى 13 تشرين الأول (أكتوبر))

  • أنشئ المستندات التالية حول إنشاء فيديوهات في MediaWiki:

    • دليل سريع للمستخدمين حول "إنشاء تسجيل رقمي عام للشاشة" يشير إلى مشروع Screencast
    • نماذج لـ: أدلة إرشادية حول استخدام برنامج أو أداة، وأدلة تعليمية حول تطوير أدوات جديدة

  • أنشئ قائمة بأفكار لإنشاء تسجيلات رقمية للشاشة في MediaWiki.

الأسبوع 7 (من 14 إلى 20 تشرين الأول (أكتوبر))

  • العمل على فيديو ""مقدّمة عن Phabricator"":

    • استخدِم النموذج (الذي تم إنشاؤه في الأسبوع الماضي) لصياغة نص برمجي.
    • يمكنك تقدير فعالية النموذج وتحسينه إذا لزم الأمر.
    • الحصول على ملاحظات ووضع المسودة في شكلها النهائي

الأسبوع 8 (من 21 إلى 27 تشرين الأول (أكتوبر))

  • نشر فيديو "Introduction to Phabricator":

    • اختَر البرنامج وثبِّته.
    • إعداد البيئة وإنشاء التسجيل الرقمي للشاشة
    • دوِّن المشاكل التي واجهتها والحلول التي تم اتّخاذها.

الأسبوع 9 (من 28 تشرين الأول (أكتوبر) إلى 3 تشرين الثاني (نوفمبر))

  • العمل على تحسين وثائق مشروع Screencast:

    • راجِع البنية وناقش أيّ حاجة إلى إجراء تغييرات.
    • راجِع البرامج المذكورة.
    • البحث عن قائمة البرامج وتعديلها

الأسبوع 10 (4 - 10 نوفمبر)

  • مواصلة تحسين مستندات مشروع Screencast:

    • تقييم البرنامج التعليمي والنصوص وتحسينه.
    • راجِع معرض تسجيلات الشاشة.

الأسبوع 11 (من 11 إلى 17 تشرين الثاني (نوفمبر))

  • أكمِل العمل على مستندات مشروع Screencast:

    • العثور على فيديوهات أحدث وإضافتها إلى المعرض
    • أدخِل التغييرات الهيكلية اللازمة.

الأسبوع 12 (من 18 إلى 24 تشرين الثاني (نوفمبر))

  • العمل على أي مهام في انتظار المراجعة.

  • كتابة التقرير النهائي:

    • راجِع التقارير الأسبوعية أو اليومية واجمع المعلومات المطلوبة.
    • خطط لبنية التقرير واكتب مسودة.
    • تحسين المسودة ووضع اللمسات النهائية عليها استنادًا إلى ملاحظات المرشد

الأسبوع 13 (25 - 29 نوفمبر)

  • أرسِل التقرير النهائي وتقييم المرشد.

6- تتبُّع مستوى التقدّم

سيتم إرسال آخر المعلومات حول مستوى التقدّم يوميًا إلى المرشدين عبر Zulip. يمكن للمنتدى في Wikimedia تتبُّع مستوى تقدّمي من خلال Phabricator أو تقارير المشاريع التي يتم إصدارها كل أسبوعَين.

7- التزامات أخرى

أنا طالب جامعي بدوام كامل ويتداخل الفصل الدراسي للخريطة الزمنية لموسم "مستندات Google". وبالتالي، تشمل التزاماتي امتحانات الكلية.

الامتحان الداخلي الأول: من 18 إلى 24 آب (أغسطس)

الاختبار الداخلي الثاني: من 29 أيلول (سبتمبر) إلى 6 تشرين الأول (أكتوبر)

امتحان نهاية الفصل الدراسي: من 11 إلى 30 تشرين الثاني (نوفمبر)

أخطّط أيضًا لحضور أول مؤتمر علني لي، وهو PyCon India، وذلك من 12 إلى 15 تشرين الأول (أكتوبر)، وذلك بفضل الموقع الجغرافي الملائم هذا العام. أعتقد أنّ هذه فرصة رائعة للتعرّف على أشخاص جدد وإجراء محادثات مفيدة.

لإدارة هذه الالتزامات، يحتوي المخطط الزمني التقريبي على مهام أقل أهمية في الأسابيع المقابلة. أنوي إكمال ما لا يزيد عن 20 وحدة دراسية أساسية في الفصل الدراسي الخريفي كي يتسنى لي الحصول على الوقت الكافي لتطوير المستندات. (يُكمل الطالب العادي 25 وحدة دراسية في المتوسط لكل فصل دراسي)