تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من 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 لكتابة الوثائق. أنا أيضًا مبتدئ عندما يتعلق الأمر بمكتبة مات بلوت ليب ومكتبة جيت. سيستغرق التعامل مع هذه الأنظمة الأربعة والشعور بالراحة عند استخدامها للتعاون والبحث بعض الوقت. سأحتاج إلى تفويض الوقت خلال مرحلة الترابط بين أفراد المنتدى وفي مرحلة مبكرة من أجل بناء الأساس اللازم لمسارات مستوى المبتدئين. خلال هذه الفترة، إذا واجهتُ مشاكل في المفاهيم والأساسيات، سأحتاج إلى التواصل مع المنتدى للحصول على دعم إضافي.
سيستغرق تنسيق الجهود التعاونية عبر المناطق الزمنية وعبر المنصات على الإنترنت بعض التعديلات أيضًا. هناك مجموعة متنوعة من طرق الاتصال التي يستخدمها الأشخاص في جميع أنحاء الصناعة، لذلك فإن الأمر يهم بالتأكد من أنه يمكن الوصول إليه بسهولة وفي جميع الوسائط. سألتزم بالشفافية عند تحديد أولوياتي للتوقعات المختلفة خلال العملية. على الرغم من أنني بدأت للتو في تولي أعمال كهذه في المجال، فإنّني استثمرت في محاسبة نفسي والانفتاح على الملاحظات والنقد. أشعر أن هذه الصفات قيّمة بغض النظر عن المجال.
كما أن زيادة اختبار قابلية الاستخدام هي قسم من الوثائق التي أعتقد أنها ستفيد مسارات دخول مكتبة مات بلوت ليب. يهدف إجراء استبيانات لقابلية الاستخدام فيما يتعلق بالمحتوى إلى توفير ملف شخصي للمستخدم، أي الشخصيات. تعد معلومات مثل تجربة المستخدم ومجاله وسجلّ استكشاف الأخطاء وإصلاحها ذات قيمة. هذه القطع تساعد في تشكيل اللغة وراء الإجراء. عندما يلتقي المحتوى بالقرّاء في مستواهم، ينضج المحتوى ليصبح مجرّد دليل تعليمي فقط.
غالبًا ما تكمن الصعوبات الكبيرة في إنشاء ممارسة مستمرة لاختبار قابلية الاستخدام. من الشائع جدًا أن يتم إجراء مثيل واحد من الاختبار خلال عملية تطوير المحتوى، إذا تم ذلك من الأساس. يساعد اختبار قابلية الاستخدام المنتظم في قيادة سرد المحتوى. أتمنى أن أقوم بإعداد جدول زمني أو إجراء اختبارات قابلية استخدام متكررة مع مجتمع مكتبة مات بلوت ليب.
الخلاصة
لدي خبرة بسيطة في استخدام بايثون ومكتبة مات بلوت ليب في وقت فراغي. التعليم الذي علّمته خلال الأشهر القليلة الماضية كان بمساعدة الوثائق الحالية وفضولي. كان هناك عدد قليل من مقاطع الفيديو والمرشدين الذين شاركتهم في ذلك الوقت أيضًا. لا يزال لديّ الكثير لأتعلّمه فضلاً عن المزيد من فرص التحسين بينما أعمل على إنشاء منهجي الخاص في مجال البرمجة.
بعد رؤية الأفكار التي تمتلكها مكتبة مات بلوت ليب والمجتمع حول GSoD، أشعر أنها ستكون تجربة متنامية ممتازة لتحسين مهاراتي ككاتب تقني والحصول على فرصة تعلم المزيد من الأشخاص وراء الكواليس. لقد شعرت أن مشروع مكتبة مات بلوت ليب هذا ذي معنى وشغوف به في الأيديولوجية.
من أجل العمل على إصلاح دليل الاستخدام، فإن هدفي ككاتب تقني هو مساعدة المستخدمين على إنجاز المهام التي يريدونها دون الشعور بالإرهاق من الميزات المتاحة. أعتقد أنّ أفضل الوثائق ستستمر في النمو والتكيّف مع المستخدمين والسماح لأي مستخدم بالانتقال إلى الحلول الخاصة به.