تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- مكتبة مات بلوت ليب
- الكاتب الفني:
- جيروم
- اسم المشروع:
- تطوير مسارات إدخال مكتبة مات بلوت ليب
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
مقدمة
يتضمن اقتراح مشروع Matplotlib لموسم "مستندات Google" لهذا العام إنشاء محتوى يساعد في تعريف المستخدمين الجدد على Matplotlib. لتطوير مسارات إدخال Matplotlib، نقترح نهجًا بديلاً عن النهج المُستخدَم في المستندات الحالية. أنا كاتب فني جديد في المجال، ولكنّ خبرتي تتعلّق بالتعليم والمجالات ذات الصلة به. هناك تشابهات قوية بين الكتابة الفنية والتعليم، حيث يركز كلاهما على إنتاج محتوى يتعاطف مع المستخدمين ويمكّنهم من إنجاز مهامهم باستخدام الموارد المقدَّمة.
في هذا السياق، ستستفيد وثائق مكتبة مات بلوت ليب من تحسين التعاطف مع المستخدمين الجدد. تتألف معظم المواد في الوقت الحالي من بيانات عشوائية ومرئيات غير مصنّفة. وهي ممتازة لعرض المرئيات وميزات مكتبة Matplotlib بسرعة. ومع ذلك، بالنسبة إلى حالة الاستخدام لشخص جديد في مكتبة مات بلوت ليب، من الصعب اجتياز تحويل البيانات إلى عناصر مرئية.
يشكّل السياق في الأسلوب التوضيحي حلًا لهذه العقبة. من خلال كتابة إجراء من خلال عدسة مثال واقعي، نوضّح فهمنا للبيئة التي يعمل فيها المستخدم. هذا يحسن العلاقة بين الوثائق والمستخدم من حيث الوصول إلى الهدف أو توقع إنجاز مهمة.
يكون لدى المستخدِم غرض مشتقّ ثابت. على سبيل المثال، على عالم البيانات في شركة أحذية تقديم بيانات العملاء لفريق لتوضيح مؤشرات التسوّق بمرور الوقت. في هذه الحالة، يجب أن يتعلم المستخدم كيفية التنقّل في Matplotlib والاستفادة من الأدوات المتوفّرة في المكتبة لإكمال المهمة المعنيّة.
مع سياق إضافي لدعم المستندات، قد يكون المستخدم الجديد أكثر قدرة على التعرف على الموضوع. الغرض المشتق من المستخدم موازٍ للوثائق. آمل أن أعمل على تحقيق الرؤية التي ناقشها قائد المطوّر توم كاسويل في مقابلة عام 2017، وهي "وجود شخص يمكنه الكتابة بالفعل ويتعاطف مع المستخدمين، من أجل الاطّلاع على كتاب "مقدمة عن مكتبة مات بلوت ليب" وكتابة 200 صفحة بشكل أساسي، وجعله المدخل الرئيسي للمستندات".
نهج بديل للكتابة التفسيرية
توضِّح المستندات الحالية ميزات مكتبة Matplotlib، أي الإجراءات التي يمكن للمستخدم تنفيذها باستخدام المكتبة. على سبيل المثال، غالبًا ما يتبع البرنامج التعليمي النمط الذي لا يتضمن شرحًا للطريقة الأساسية.
{what the method does} -> {parameters} -> {returns} -> {related links} -> {examples}
في كثير من الأحيان، عند استخدام مستندات البرمجة ودعم المستخدمين، يُنصح المستخدم بتشغيل الرمز البرمجي بنفسه لفهم ما يحدث. على الرغم من أنّ التفكير البرمجي يُحسِّن من فهم المستخدم للموضوع، إلا أنّ منحنى التعلّم للتحويلات لا يحتوي على محتوى داعم كافٍ. قد يكون تحديًا شاقًا لأن التوثيق محدود.
سيساعد تقديم مخططات أو صور أو عناصر مرئية أخرى إضافية في توفير فرص تعلّم جديدة. يمكنك أيضًا استخدام البنية أدناه كنموذج للمحتوى الجديد. بالإضافة إلى ذلك، يمكن أن تستفيد من ميزات مثل وسائل الشرح والعلامات التوضيحية عند إضافة صور أو رسومات غير نصية. في بعض الأحيان، يكون من الصعب التنقّل في الصور بدون مؤشرات حول كيفية تحويل الرمز البرمجي إلى الإخراج الذي يتم تنفيذه أو مكان تنفيذه. أعتقد أنّه لا يتوفّر عنصر بصري قوي يمكن أن يساعد في فهم المواضيع بشكل أفضل.
{method explanation} -> {expository use case/scenario} -> {sample code} -> {parameters} -> {returns} -> {additional examples} -> {informational topic/subject affinity links}
هناك إمكانات هائلة في هذا النهج البديل لاستخدام الكتابة التوضيحية في المستندات. ومن خلال عرض مجموعة متنوعة من مفاهيم عمليات التحويل، سيتمكّن المستخدمون من تحديد الاستراتيجيات الأساسية لتطوير الرسومات البيانية للبيانات بشكل أفضل. يمكن أن تساعد هذه المعرفة المستخدمين في الابتكار والاستفادة من الميزات كما هو موضّح في الأمثلة المستندة إلى حالات استخدام واقعية.
مع تزايد رواج مكتبة Matplotlib، يُعدّ اتساق سهولة الاستخدام وسهولة الفهم دليلاً على سمعة المكتبة. تفسح هذه الخصائص نفسها لإظهار الأنماط والاستراتيجيات الشائعة التي يمكن أن تظهر ليس فقط داخل التعليمة البرمجية، ولكن أيضًا ضمن الوثائق. إذا كانت مكتبة مات بلوت ليب بسيطة وعادية بالنسبة إلى المستخدمين، يتضح من استخدامها المتزايد وتوسيع الموارد، فقد تكون هذه الطريقة كذلك بالنسبة إلى الوثائق الفنية.
عندما يواجه المستخدمون مشكلات، من الشائع استخدام البحث لحلها. بدلاً من الاعتماد على البحث كطريقة أساسية للتنقّل، قد يكون من الأفضل أن ينشئ المستخدمون منهجهم الخاص ضمن المستندات. في هذا السياق، يبحث المستخدم عن حلّ لمشكلته، ثمّ عندما يواجه مشكلة أخرى أو يريد الحصول على معلومات إضافية، سيستفيد من الروابط المضمّنة والمفصّلة في جميع الأقسام.
سيتضمّن ذلك بنية من أسفل إلى أعلى في النظام التنظيمي. بالنسبة إلى كل موضوع ضمن Matplotlib، ستساعد شبكة غنية من الروابط إلى التشابهات بين المواضيع والمواضيع المعلوماتية في إنشاء شبكة قوية. وفي هذه الشبكة، من المرجّح أن يواصل المستخدم استخدام المستندات أثناء تنقّله إلى موضوعه واستكشاف المزيد من المعلومات ذات الصلة به.
العقبات
هناك دائمًا تحديات في مشروع شامل ومفصّل مثل هذا. بصفتي كاتبًا تقنيًا جديدًا في المجال، لديّ خبرة محدودة في استخدام Sphinx وReST لكتابة المستندات. أنا أيضًا مبتدئ عندما يتعلق الأمر بمكتبة مات بلوت ليب وكذلك جيت. سيستغرق التعامل مع هذه الأنظمة الأربعة والاعتياد على استخدامها في التعاون والأبحاث بعض الوقت. سأحتاج إلى تخصيص الوقت خلال مرحلة توطيد العلاقات بين أفراد المنتدى وفي مرحلة مبكرة من أجل وضع الأساس اللازم لمسارات مستوى الدخول. خلال هذه الفترة، إذا واجهت مشاكل في المفاهيم والأسس، سأحتاج إلى التواصل مع المنتدى للحصول على دعم إضافي.
كما سيتطلب تنسيق الجهود التعاونية عبر المناطق الزمنية وعبر المنصات عبر الإنترنت بعض التعديلات. هناك مجموعة متنوعة من قنوات التواصل التي يستخدمها الأشخاص في جميع أنحاء المجال، لذا من المهم التأكّد من أنّه يمكن التواصل معي بسهولة في جميع الوسائط. سأكون منفتحًا بشأن الأولوية التي أعطيها للتوقعات المختلفة طوال الوقت. على الرغم من أنّني بدأت للتو في تولي أعمال مماثلة في المجال، إلا أنّني أحرص على تحمّل المسؤولية والتأهّل لتلقّي الملاحظات والانتقادات. أعتقد أنّ هذه الصفات قيّمة بغض النظر عن المجال.
بالإضافة إلى ذلك، فإنّ زيادة اختبار قابلية الاستخدام هو قسم من المستندات التي أعتقد أنّها ستعود بالفائدة على مسارات إدخال Matplotlib. يهدف إجراء استطلاعات حول قابلية استخدام المحتوى إلى توفير ملف شخصي للمستخدم، أي شخصيات المستخدمين. إنّ المعلومات، مثل تجربة المستخدم وفئته المهنية وسجلّ تحديد المشاكل وحلّها، هي معلومات قيّمة. تساعد هذه القطع في تشكيل لغة الإجراء. عندما تتوافق الكتابة مع مستوى القرّاء، يصبح المحتوى أكثر نضجًا من مجرد محتوى تعليمي.
غالبًا ما تواجهك مشاكل كبيرة في إنشاء ممارسة مستمرة لاختبار قابلية الاستخدام. من الشائع جدًا أن تُجري عملية اختبار واحدة، في حال تم إجراؤها، خلال عملية تطوير المحتوى. يساعد اختبار سهولة الاستخدام المنتظم في تعزيز قصة المحتوى. نأمل إعداد جدول زمني أو إجراء اختبارات متكررة لسهولة الاستخدام مع منتدى Matplotlib.
الخاتمة
لديّ خبرة قليلة في استخدام Python وMatplotlib في وقت فراغي. لقد تعلّمتُ الكثير من خلال الاطّلاع على المستندات الحالية وفضولي الشخصي خلال الأشهر القليلة الماضية. وشاهدتُ أيضًا عددًا من الفيديوهات واستفدت من نصائح عدد من الخبراء. ولا يزال لدي الكثير لأتعلمه ومجالًا أكبر للتحسين حيث أقوم ببناء منهج البرمجة الذي يهمني.
بعد رؤية الأفكار التي تمتلكها مكتبة مات بلوت ليب والمجتمع حول GSoD، أشعر أنها ستكون تجربة نمو ممتازة لتحسين مهاراتي ككاتب تقني والحصول على فرصة لمعرفة المزيد من الأشخاص وراء الكواليس. لقد شعرت أن مشروع مكتبة مات بلوت ليب هذا له مغزى وشيء أنا متحمس له في الأيديولوجية.
في ما يتعلّق بالعمل على إجراء مراجعة شاملة لدليل الاستخدام، هدفي بصفتي كاتبًا تقنيًا هو مساعدة المستخدمين في إنجاز المهام التي يريدونها بدون أن يشعروا بالإرهاق بسبب الميزات المتاحة. أعتقد أنّ أفضل المستندات ستستمر في النمو والتكيّف مع المستخدمين والسماح لأي مستخدم بالانتقال إلى الحلول الخاصة به.