تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول ضمن "موسم المستندات" من Google.
ملخص المشروع
- مؤسسة البرامج المفتوحة المصدر:
- VLC
- الكاتب الفني:
- آفي
- اسم المشروع:
- إنشاء مستندات مستخدم VLC لمنفذ واحد للأجهزة الجوّالة (Android)
- طول المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تجريدي
تُستخدم وثائق المستخدم كنظام دعم ثابت لمساعدة المستخدمين. توفّر هذه السمة المعلومات الفنية وغير الفنية حول منتج أو خدمة. تساعد المستخدمين في تعلم كيفية استخدام البرامج أو الخدمات. لا يريد كل شخص التواصل مع فريق الدعم أو انتظار الرد عبر البريد الإلكتروني إذا كان كل ما يحتاج إليه هو توجيه أو نصائح أو حيلة بسيطة. تقوم وثائق المستخدم بذلك فقط. كما أنه يقلل من تكاليف الدعم ويمثل مدى صحة المنتج وفريق المطورين.
وقد تم تنزيل VLC لأجهزة Android أكثر من 100 مليون مرة من "متجر Google Play" فقط. يوفر VLC الكثير من الميزات لمنافذ الجوّال التابعة له، بدءًا من تشغيل الصوت والفيديو ووصولاً إلى البث عبر الشبكة. غالبًا ما يرغب الأشخاص في استخدام هذه الميزات الرائعة غير أنّهم غير قادرين على استخدامها. فالبحث عن مدونة أو مقطع فيديو عشوائي لذلك يتطلب الكثير من الوقت والصبر، ومع ذلك، لا توجد صحة المعلومات التي تم الحصول عليها. وفي الوقت الحالي، يستضيف برنامج VLC برنامج VLC لبرنامج Android على صفحة wiki ويقدم وصفًا أقل لهذه الميزات أو لا يوفر وصفًا لهذه الميزات. بالإضافة إلى ذلك، تمّ إجراء آخر تعديل على صفحات ويكي في آذار (مارس) 2019. سيوفر المشروع الحالي وثائق جديدة للمستخدم بتصميم حديث وسهولة استخدام أكبر لمنفذ Android.
الوضع الحالي
صفحات wiki قديمة تمامًا وتحتوي على معلومات أقل جدًا حول أحدث إصدار من VLC. كما أنه ليس من السهل التنقل فيها. لا يتوفّر خيار مرئي لقراءة المستندات بلغة أخرى غير الإنجليزية. لا يحتوي على أوصاف الميزات على الإطلاق.
التحليل
-> في الوقت الحالي، أصبحت المستندات الحالية قديمة ويجب كتابتها بطريقة جديدة وباستخدام منصة وأدوات مختلفة.
-> يمتلك معظم مستخدمي Android القليل من المعرفة الفنية أو ليس لديهم معرفة تقنية على الإطلاق. لكن هناك أشخاص يحتاجون إلى مزيد من المعلومات الفنية حول إحدى الميزات. ولا تُعد كتابة مستندين منفصلين لكل غرض من الأغراض المذكورة أعلاه والاحتفاظ به فكرة جيدة. أو حتى في نفس الوثائق، يؤدي تقسيم الميزة على أساس فني وغير فني إلى إرباك إضافي. نظرًا لأن معظم المستخدمين اعتادوا مرة أخرى على واجهة المستخدم التي يرونها أو الميزات التي يستخدمونها، فلن يكون من السهل على الجميع أن يقرروا ما إذا كان الشيء تقنيًا أو غير تقني. لذا نود تبسيط هذا الأمر لهم.
-> سيحاول معظم المستخدمين الحصول على المعلومات من خلال هواتفهم الذكية والاستراحة من خلال سطح المكتب أو الأجهزة الأخرى. لذلك يجب أن تكون الوثائق قابلة للتكيف بسهولة مع كل حجم شاشة. ولن تسبب أي التباس بشأن التنقل.
-> كل ميزة من ميزات إصدار سطح المكتب غير متوفرة في منفذ android، وإذا كانت متاحة، فإنها لا تعمل بالطريقة نفسها في كلا المنفذين. وذلك لأنّ تطبيق سطح المكتب كان في مرحلة التطوير منذ وقت طويل وبلغ نوعًا من التشبع، وفي المقابل، يعد منفذ الهاتف المحمول جديدًا نسبيًا ولا يزال قيد التطوير. وبخلاف ذلك، على الرغم من أن الأجهزة المحمولة في الوقت الحاضر أصبحت قوية للغاية، هناك قيود واضحة على نوع الميزة التي يمكننا دمجها في الغالب بسبب طلب المستخدم النهائي. إن وجود ميزة لا يستخدمها أحد يُعد إهدارًا لموارد التطوير. ولذلك لا يُنصح بتحويل كلا المستندَين على أساس الميزات.
استنادًا إلى التحليل أعلاه، أقترح ما يلي. 1- تستخدم وثائق مستخدم سطح المكتب حاليًا أداة إنشاء وثائق Sphinx وقراءة مظهر المستندات. سيساعدنا استخدام الطريقة نفسها في منفذ Android بالطرق التالية: -> دمج كلا المستندَين بسهولة. -> يناسب جميع أحجام الشاشات -> تجربة سلسة عند الانتقال إلى مستندات المستخدم في Android من خلال مستندات سطح المكتب
- فصل الفصول والأقسام والأقسام الفرعية وفقًا لموضعها النسبي في التطبيق. على سبيل المثال، يمكنك العثور على وضع "الخلفية/نافذة ضمن النافذة" (PiP) ضمن "المزيد" -> الإعدادات-> الفيديو، وبالتالي ستظهر بنية الفصل
- المزيد
- |__الإعدادات
- | |__مكتبة الوسائط
- | |__Video -->وضع الخلفية/PiP
- : -> سيعمل هذا النهج على تحسين سهولة الوصول إلى المحتوى لأنّ المستخدمين سيتمكّنون من الانتقال بسهولة إلى الجزء الذي يحتاجون إلى المساعدة فيه من خلال مقارنته بالموقع النسبي في التطبيق. لكل ميزة من الميزات، يمكننا كذلك فصل الأجزاء الفنية وغير الفنية. سنكتب أولاً وصفًا غير تقني سهلاً، ثم نسلّط الضوء على الأجزاء الفنية للميزة نفسها أو نسميها، إن وجدت، تحتها مباشرة. قد يؤدي هذا إلى بعض التكرار ولكنه سيضمن تجربة سلسة للأغلبية غير الفنية. سيساعد هذا أيضًا في المستقبل في المستقبل من خلال زيادة قابلية صيانته. ونظرًا لأن التطبيق سيصل إلى حالة تشبع اللون، من غير المحتمل أن تتغير واجهة المستخدم النسبية كثيرًا، وبالتالي إذا تمت إضافة/إزالة ميزة جديدة، يمكننا ببساطة إعادة بناء القسم. في حال تغيير واجهة المستخدم بالكامل، يمكننا إعادة ترتيب الأقسام/الفصول أو إعادة هيكلة المستند بأكمله، وفي كلتا الحالتين، نحتاج إلى تعديل الوثائق بأكملها لأنّه يجب استبدال لقطة الشاشة لتتطابق مع واجهة المستخدم الحالية. تتم استضافة عرض توضيحي عملي هنا : https://avinal.gitlab.io/vlc-android-docs/
يجب أن يتكون كل قسم من الوثائق من لقطة شاشة معبرة، ووصف الميزة، وجزءًا أكثر تقنية في حالة وجود أي نصائح وحيل للميزة.
-> سيساعدنا تطوير مستندات المستخدم هذه بشكل مستقل من سطح المكتب في دمج المستندين في خطوات قليلة فقط بدون التأثير في المستندات الحالية أو التأثر بها أثناء التطوير. أقترح وضع هذه الوثائق بالكامل في قسم Android لوثائق سطح المكتب بمجرد تطويرها، ثم إنشاء رابط ثابت لوثائق VLC لـ android.
-> قد تتضمن المزيد من التحسينات إعادة تصميم الصفحة الرئيسية لوثائق مستخدم سطح المكتب للسماح للمستخدمين باختيار نظام التشغيل المفضل لديهم مباشرةً ثم إعادة التوجيه إلى وثائق نظام التشغيل المختار. بما أنّ وثائق مستخدم VLC في أنظمة التشغيل Windows وMacOS وLinux تم تصميمها جيدًا وتم تحويلها، يمكننا وضع خيارات للاختيار من بينها في أنظمة التشغيل Windows/MacOS/Linux أو Android أو iOS. سيؤدي ذلك إلى فصل وثائق المستخدم بشكل جيد ولكن موحدة مع رابط واحد فقط للاستخدام مع جميع المنافذ.
لماذا من الأفضل استخدام وثائق المستخدم المقترحة؟ وتكون مستندات المستخدم المقترَحة هذه منظَّمة على أساس الأنماط الشائعة التي يتبعها المستخدم النهائي للحصول على المساعدة. وتجمع المستندات بين جميع الميزات المطلوبة، مثل البساطة والوضوح والشكل والمظهر والمعرفة التقنية لزيادة سهولة الاستخدام وتجربة المستخدم النهائي إلى أقصى حد. يمكن أيضًا الاحتفاظ بهذه البيانات بسهولة نظرًا لعدم الحاجة إلى الاحتفاظ بوثائق المستخدم الفردية لكل منفذ.
لماذا أنا الشخص المناسب لهذا المشروع؟ -> كنت أكتب الرموز منذ سنتين وغالبًا ما أحتاج إلى مراجعة وثائق واجهة برمجة التطبيقات لمكتبات معيّنة أو بعض البرامج أو حتى توثيق التعليمات البرمجية الخاصة بي. لذلك أعرف بالضبط ما يريد المستخدمون رؤيته في الوثائق، والمشكلة التي يواجهونها وكيف يتعاملون مع المساعدة. سأكون قادرًا على تطبيق التجربة نفسها لكتابة وثائق متسقة وسهلة القراءة.
-> كنت أكتب معلومات تقنية بشكل نشط على Quora وStack Overflow والعديد من المنصات الأخرى. أعلم كيفية شرح الأشياء بطريقة ملفتة ويسهل فهمها.
-> VLC لنظام التشغيل Android هي أداة فعالة وشهيرة، إلا أنّ معظم ميزاتها غير معروفة أو لا تتوفر أي مساعدة منها. لقد كنت أستخدم VLC على كل من الأنظمة الأساسية لأجهزة سطح المكتب والأجهزة الجوّالة لعدة سنوات حتى الآن وأعلم المشكلات التي قد يواجهها المستخدم. من خلال الجمع بين كل معرفتي وخبرتي، يمكنني أن أؤكد على الوثائق الرائعة.