تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- مكتبة مات بلوت ليب
- الكاتب التقني:
- جيروميف
- اسم المشروع:
- تطوير مسارات دخول مكتبة مات بلوت ليب
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
مقدمة
يتضمن اقتراح مشروع مكتبة مات بلوت ليب لموسم Google هذا العام إنشاء محتوى يساعد في تقديم مكتبة مات بلوت ليب للمستخدمين الجدد. لتطوير مسارات دخول مكتبة مات بلوت ليب، أقترح نهجًا بديلاً للتوثيق الحالي. أنا كاتبة تقنية جديدة في المجال، ولكن خلفيتي هي في المجالين التعليمي والعلمي المجاورين. هناك أوجه تشابه قوية بين الكتابة الفنية والتعليمية، ما يجعلها تركّز على إنتاج محتوى يتعاطف مع المستخدمين ويتيح لهم إنجاز المهام باستخدام الموارد المتوفّرة.
في هذا السياق، ستستفيد وثائق مكتبة مات بلوت ليب من التحسين للتعاطف مع المستخدمين الجدد. يتألف جزء كبير من المواد في الوقت الحالي من بيانات عشوائية وعناصر مرئية غير مصنّفة. وهي ممتازة لعرض العناصر المرئية وميزات مكتبة مات بلوت ليب بسرعة. ومع ذلك، بالنسبة لحالة استخدام شخص جديد على مكتبة مات بلوت ليب، فمن الصعب اجتياز تحويل البيانات إلى صور.
ويُعد السياق في نهج تفسيري حلاً لهذه العقبة. من خلال كتابة إجراء من منظور مثال من العالم الحقيقي، فإننا نظهر فهمًا للبيئة التي يعمل فيها المستخدم. هذا يحسن العلاقة بين الوثائق والمستخدم من حيث الوصول إلى هدف أو توقع إنجاز مهمة.
المستخدم لديه غرض مشتق متسق، على سبيل المثال، يجب على عالم البيانات في شركة أحذية تقديم بيانات العملاء إلى فريق لتوضيح اتجاهات التسوق بمرور الوقت. في هذه الحالة، يجب أن يتعلم المستخدم كيفية التنقل في مكتبة مات بلوت ليب والاستفادة من الأدوات الموجودة داخل المكتبة لإكمال المهمة المطروحة.
مع توفير سياق إضافي لدعم الوثائق، قد يكون المستخدم الجديد أكثر قدرة على التعرف على الموضوع. الغرض المشتق من المستخدم موازٍ للوثائق. آمل أن أعمل على تحقيق الرؤية التي ناقشها رئيس المطوّر توم كاسويل في مقابلة عام 2017 وهي "وجود شخص يمكنه بالفعل الكتابة ويتعاطف مع المستخدمين، وأن يمرّ بكتاب "مقدمة عن مكتبة مات بلوت ليب" ويكتبه، وأن تكون هذه هي المدخل الرئيسي إلى المستندات".
النهج البديل للكتابة التفسيرية
توضح الوثائق الحالية ميزات مكتبة مات بلوت ليب، أي الأشياء التي يمكن للمستخدم القيام بها باستخدام المكتبة. على سبيل المثال، غالبًا ما يتبع البرنامج التعليمي النمط الذي لا يتضمن شرحًا للطريقة الأساسية.
{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}
هناك إمكانات هائلة في هذا النهج البديل لاستخدام الكتابة التحريرية للتوثيق. مع رؤية المستخدمين لمجموعة متنوعة من المفاهيم لعمليات التحويل، سيكونوا قادرين على تحديد الاستراتيجيات الأساسية بشكل أفضل لتطوير التصورات للبيانات. يمكن أن تساعد هذه المعرفة المستخدمين على الابتكار والاستفادة من الميزات كما هي مقدَّمة من أمثلة تستند إلى حالات استخدام واقعية.
مع زيادة شعبية مكتبة مات بلوت ليب، أصبح الاتساق في سهولة الاستخدام وسهولة الوصول دليلاً على سمعة المكتبة. تتيح هذه الخصائص إظهار الأنماط والاستراتيجيات الشائعة التي يمكن أن تظهر ليس فقط داخل التعليمة البرمجية ولكن أيضًا داخل الوثائق. إذا كانت مكتبة مات بلوت ليب واضحة وعادية بالنسبة إلى المستخدمين للبرمجة، كما يتضح في استخدامها المتزايد ومواردها الموسّعة، يمكن أن تكون هذه هي الطريقة أيضًا للتوثيق الفني.
عندما يواجه المستخدمون مشكلات، من الشائع استخدام البحث لحلها. وبدلاً من الاعتماد على البحث كطريقة أساسية للتنقل، قد يكون من الأفضل أن ينشئ المستخدمون مناهجهم الخاصة ضمن المستندات. بهذا المعنى، يبحث المستخدم عن حل لمشكلته، ثم عندما يواجه مشكلة أخرى أو يريد الحصول على معلومات إضافية، فسيستفيد من الروابط المضمنة والشاملة طوال الوقت.
وهذا من شأنه أن يتضمن بنية من أسفل إلى أعلى في النظام التنظيمي. بالنسبة إلى كل موضوع في مكتبة مات بلوت ليب، ستساعد شبكة واسعة من الروابط المؤدية إلى التقاربات ذات الصلة بالموضوعات بالإضافة إلى المواضيع الإعلامية في بناء شبكة قوية. خلال هذه الشبكة، من المرجح أن يواصل المستخدم استخدام الوثائق أثناء انتقاله إلى موضوعه واستكشاف المزيد والمزيد من المعلومات المتعلقة بهذا الموضوع.
العقبات
هناك دائمًا تحديات مع مشروع شامل ومفصل مثل هذا. وبصفتي كاتبًا تقنيًا جديدًا في المجال، لدي خبرة محدودة في استخدام Sphinx وReST لكتابة الوثائق. أنا أيضًا مبتدئ عندما يتعلق الأمر بمكتبة مات بلوت ليب بالإضافة إلى Git. ستستغرق معالجة هذه الأنظمة الأربعة والشعور بالراحة عند استخدامها للتعاون والبحث وقتًا طويلاً. سأحتاج إلى تفويض الوقت خلال مرحلة الترابط بين أفراد المنتدى وما قبله من أجل بناء الأساس اللازم لمسارات مستوى المبتدئين. خلال هذه الفترة، إذا واجهتُ مشاكل في المفاهيم والأساسيات، أحتاج إلى التواصل مع المنتدى للحصول على المزيد من الدعم.
كما أن تنسيق الجهود التعاونية عبر المناطق الزمنية وعبر المنصات عبر الإنترنت سيستغرق بعض التعديلات أيضًا. هناك مجموعة متنوعة من طرق التواصل التي يستخدمها الناس في جميع أنحاء الصناعة، لذلك فإن الأمر يتعلق بالتأكد من سهولة الوصول إلى موقعي الإلكتروني وسهولة الوصول إليه في جميع الوسائط. سأحرص على تحديد أولوياتي لمختلف التوقّعات خلال هذه العملية. على الرغم من أنني بدأت للتو في تولي مهام كهذه في المجال، فإنّني أستثمر في محاسبة نفسي ومنفتح على الملاحظات والنقد. أشعر أن هذه الصفات قيّمة بغض النظر عن المجال.
أيضًا، زيادة اختبار قابلية الاستخدام هي قسم من الوثائق التي أعتقد أنها ستفيد مسارات دخول مكتبة مات بلوت ليب. يهدف إجراء استبيانات لقابلية الاستخدام فيما يتعلق بالمحتوى إلى توفير ملف تعريفي للمستخدم، مثل الشخصيات. تعد معلومات مثل تجربة المستخدم ومجاله وسجل استكشاف الأخطاء وإصلاحها ذات قيمة. هذه القطع تساعد في تشكيل اللغة وراء الإجراء. عندما يلتقي المحتوى بالقرّاء في مستواهم، يتطوّر المحتوى أكثر من مجرد تقديم محتوى تعليمي فقط.
غالبًا ما تكمن الصعوبات الكبيرة في إنشاء ممارسة مستمرة لاختبار قابلية الاستخدام. من الشائع جدًا أن يتم إجراء مثيل واحد من الاختبار خلال عملية تطوير المحتوى، إذا تم ذلك على الإطلاق. يساعد اختبار قابلية الاستخدام المنتظم في قيادة سرد المحتوى. سأأمل في إعداد جدول زمني أو إجراء اختبارات متكررة لقابلية الاستخدام مع مجتمع مكتبة مات بلوت ليب.
الخاتمة
لدي خبرة بسيطة في استخدام بايثون مع مكتبة مات بلوت ليب في وقت فراغي. لقد علمتُ نفسي خلال الأشهر القليلة الماضية بدعم من الوثائق الحالية وفضولي الخاص. كان هناك عدد قليل من مقاطع الفيديو والمعلمين الذين شاركتُ معهم في ذلك الوقت أيضًا. لا أزال أمامي الكثير لتعلّمه، وهناك مساحة إضافية للتحسين بينما أطوّر منهجي الدراسي الخاص بالبرمجة والذي يهمني.
بعد رؤية الأفكار التي توفرها مكتبة مات بلوت ليب والمجتمع حول GSoD، أشعر أنها ستكون تجربة متنامية ممتازة لتحسين مهاراتي ككاتب تقني والحصول على فرصة للتعرف على المزيد من الأشخاص وراء الكواليس. لقد شعرت أن مشروع مكتبة مات بلوت ليب هذا ذو معنى وشغوفًا به في الأيديولوجية.
من أجل العمل على إصلاح دليل الاستخدام، فإن هدفي ككاتب تقني هو مساعدة المستخدمين على إنجاز المهام التي يريدونها دون التشتت من الميزات المتاحة. أعتقد أنّ أفضل المستندات ستستمر في التطوّر والتكيّف مع المستخدمين وستسمح لأي مستخدم بالانتقال إلى حلوله الخاصة.