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

تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من 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).

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

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