مشروع مؤسسة Wikimedia

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

ملخص المشروع

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

وصف المشروع

1- لمحة عني

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

كانت رحلتي حتى الآن لحظات شيّقة ومربكة شملت الكثير من العبارات: اكتسبتُ معلومات جديدة كل يوم، بدءًا من تعديل الصفحات ووصولاً إلى إنشاء الإضافات.

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

2. المشروع

2.1. المخطط

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

2.2. مواد العرض

  • T197006 [https://phabricator.wikimedia.org/T197006] - تحسين الوثائق لوثائقي Wikimedia:

    • أضِف نصائح وأمثلة إلى دليل التوثيق/الأسلوب. [https://www.mediawiki.org/wiki/Documentation/Style_guide]
    • أضف معلومات خاصة بـ MediaWiki إلى أنواع معينة في نماذج واقتراحات الوثائق الفنية: أدلة المستخدم، والإرشادات التوجيهية، وأدلة البدء السريع، وملاحظات الإصدار، وقراءة التعليمات. [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. الموجّهون

سيكون زوليب هو وسيلة التواصل الأساسية مع المعلمين. سيتم استخدام قنوات IRC وقنوات IRC المتعلقة بالنقاشات مع المنتدى. ستحدث مناقشات حول مهام محددة في قسم التعليقات في مهام المُجسّد.

4. مناقشة

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

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

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

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

في الماضي، كانت هناك العديد من المبادرات لتحسين وثائق 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

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

في ما يلي مقتطف من التقرير الذي يُصدر كلّ أسبوعَين عن أحد المتدربين في برنامج Outreachy لعام 2018، وهي Anna e só https://anna.flourishing.stream/2018/01/18/bringing-documentation-to-light/:

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

يسلّط القسم T197006 [https://phabricator.wikimedia.org/T197006] الضوء أيضًا على بعض جوانب مستندات الكتابة الفنية التي تحتاج إلى تحسين. من الواضح أن التوثيق/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 أيلول (سبتمبر))

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

  • مناقشة حول:

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

  • إنشاء المهام والمهام الفرعية المطلوبة على أداة قياس المسافات.

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

الأسبوع 1 (2 - 8 سبتمبر)

  • تحسين الوثائق/Style_guide:

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

  • تحسين دليل الكُتّاب التقنيين الجدد:

    • توسيع بنية التوثيق.

الأسبوع 2 (9 - 15 سبتمبر)

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

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

الأسبوع 3 (16 - 22 سبتمبر)

  • قم بإنشاء المستندات الإضافية التالية للكتّاب التقنيين:

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

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

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

    • قم بتوثيق أفضل الممارسات على MediaWiki لكتابة أدلة المستخدم وأدلة البدء السريع وقراءة النصوص البرمجية وملاحظات الإصدار وطرق التنفيذ.

  • إضافة توجيهات لتحسين نضج التواصل الفني. [https://www.mediawiki.org/wiki/User:SRodlund_(WMF)/Maturity_model_for_MediaWiki_technical_documentation#Increasingmaturity--_strategic_directions]

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

  • تحسين المستندات لإعداد المتعاونين الجدد:

    • تعديل الصفحة: مهام الوثائق الفنية لأحداث الهاكاثون. (المهام: إضافة المهام المناسبة إلى هذه الصفحة طوال فترة المشروع)

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

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

الأسبوع 6 (7 - 13 أكتوبر)

  • قم بإنشاء الوثائق التالية حول إنشاء مقاطع فيديو لـ MediaWiki:

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

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

الأسبوع 7 (14 - 20 أكتوبر)

  • أعدّ فيديو "مقدمة إلى أداة إعادة الضبط":

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

الأسبوع 8 (21 - 27 أكتوبر)

  • انشر فيديو "مقدمة إلى أداة Fabricator":

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

الأسبوع 9 (28 أكتوبر - 3 نوفمبر)

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

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

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

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

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

الأسبوع الحادي عشر (11 - 17 نوفمبر)

  • أكمِل العمل على وثائق مشروع Screencast:

    • البحث عن فيديوهات جديدة وإضافتها إلى المعرض
    • قم بإجراء التغييرات الهيكلية اللازمة.

الأسبوع الثاني عشر (18 - 24 نوفمبر)

  • اعمل على أي مهام معلّقة.

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

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

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

  • إرسال التقرير النهائي وتقييم الموجه.

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

سيتم إبلاغ المعلمين بالتحديثات اليومية للتقدم من خلال Zulip. بإمكان مجتمع Wikimedia تتبع تقدمي من خلال Phabricator أو تقارير المشروع كل أسبوعين.

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

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

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

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

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

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

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