مشروع مكتبة سي باي

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

ملخص المشروع

مؤسسة مفتوحة المصدر:

SciPy

الكاتب الفني:

mkg33

اسم المشروع:

مستندات موجّهة للمستخدمين وإعادة تنظيم شاملة

مدة المشروع:

المدة العادية (3 أشهر)

وصف المشروع

الدوافع:

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

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

الأهداف:

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

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

استطلاع المستخدمين:

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

لقد أنشأتُ استطلاعًا أوليًا يتضمّن أسئلة نموذجية (يمكن الوصول إليه على الرابط https://docs.google.com/forms/d/e/1FAIpQLSeBAO0UFKDZyKpg2XzRslsLJVHU61ugjc18-2PVEabTQg2_6g/viewform). يجب أن يكون عدد معقول من الأسئلة في النسخة النهائية بين عشرة وخمسة عشر. للحصول على نتائج ملموسة، أقترح أننا نستخدم أسئلة الاختيار من متعدد، والمقياس الخطي، وبعض مربعات الاختيار في الغالب. ومع ذلك، يجب ألا يشبه المقياس الخطي طيفًا كاملاً (فهذا يؤدي فقط إلى حدوث التباس ومن المرجّح أن تواجه النتائج تشتتًا كبيرًا). يجب أن يكون هناك سؤالان مفتوحان كحد أقصى، وإلا ستكون النتائج مشتتة للغاية ولن تكون مفيدة على الإطلاق. أعتقد أنه حتى لو كان العدد الكبير جدًا من الردود لن يكون مشكلة لأنه يمكن تصدير البيانات وتحليلها بسهولة تلقائيًا باستخدام البرامج الإحصائية. بافتراض أنّ عدد الردود مرتفع جدًا، قد يستغرق تحليل الأسئلة المفتوحة بعض الوقت، ولكن أعتقد أنّه لن يكون مرهقًا. بعد كل شيء، من غير المرجّح أن يكتب المستخدم العادي مقالة عن حالة المستندات. في أسوأ الحالات، يمكن تخزين بعض الإجابات لتحليلها في المستقبل.

الأدلة الرسومية:

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

في ما يتعلق بتفاصيل التنفيذ، نقترح استخدام حزمة TikZ. أولاً وقبل كل شيء، هذه أداة فعّالة ولا يبدو أنّها ستتم إزالتها قريبًا. ويقدّم أيضًا نتائج عالية الجودة، ويحتوي على مستندات قوية جدًا، وهو موضوع شائع على TeX StackExchange والمنتديات الرئيسية الأخرى. الأهم من ذلك، لا يبدو أنّ دمج ملف TikZ (أو بالأحرى، الروابط الفائقة العديدة الواردة فيه) مع مستندات HTML يشكّل مشاكل كبيرة بسبب توفّر حِزم وإصلاحات مختلفة لتضمين صورة TikZ في HTML (مثل TeX4ht).

يمكن حلّ مشكلة صيانة الأدلة في SciPy في المستقبل بسهولة باستخدام، على سبيل المثال، Overleaf (لتسهيل التعاون بالإضافة إلى توفير معاينة فورية) والنماذج المحدّدة مسبقًا التي سأقدّمها. في الأساس، من غير المحتمل أن تختلف الأدلة الرسومية بشكل كبير عن بعضها البعض. ستكون البنية ولوحة الألوان والأشكال ثابتة إلى حدٍ ما، وبالتالي لن تكون إعادة التصميم لاحقًا ومزيد من التخصيص مشكلة.

(يُرجى الاطّلاع على النسخة الكاملة من الاقتراح المتوفّرة في مجلد GSoD المشترَك).