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

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

ملخص المشروع

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

SciPy

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

mkg33

اسم المشروع:

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

مدة المشروع:

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

وصف المشروع

التحفيز:

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

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

الأهداف:

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

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

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

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

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

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

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

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

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

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